One open role's detail

One open role, addressed by the (company_id, req_key) pair every /v1/jobs/search row carries -- the follow-up call for a role you already hold an identifier for, instead of re-pulling the whole company through /v1/companies/{company_id}/open-reqs.

Scoped exactly as /v1/jobs/search is: LinkedIn-excluded (ATS tenants plus public job boards and aggregators) and freshness-floored, one row per logical req. The body adds raw_title (the posting's own title) and boards -- the full, deduped list of boards reporting this req, which a search page cannot afford per row.

A req that does not exist, is closed, or has not reached the freshness floor is a 404, never an empty 200 -- and a 404 is not metered.

Requires the read scope.

get/v1/jobs/role

Request

  • Base URL: https://api.reqbeat.com
  • URL: https://api.reqbeat.com/v1/jobs/role
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

company_idinteger required

The plane's company id -- returned as company_id by /v1/reqs/search and by every company motion response.

req_keystring required

The req's own identity, as returned by /v1/jobs/search. Only unique WITHIN a company, so it is always spent together with company_id. A query parameter rather than a path segment because a board-native req id is an arbitrary string that may contain '/' or ':'.

Headers

Idempotency-Keystring nullable

Response

Successful Response

as_ofstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.