A company's hiring velocity and momentum

A company's hiring velocity/direction/momentum in one call -- the first paid route, honoring max_age (seconds). Cold (no ATS/board data at all, and max_age demands freshness beyond nothing) returns 202 {job_id, status: "crawling"} instead of a synchronous body.

Requires the read scope.

get/v1/companies/{company_id}/hiring-pulse

Request

  • Base URL: https://api.reqbeat.com
  • URL: https://api.reqbeat.com/v1/companies/{company_id}/hiring-pulse
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

company_idinteger required

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

Query parameters

max_ageinteger nullable

Maximum acceptable data age in SECONDS. A company with no data fresh enough returns 202 {job_id, status: 'crawling'} instead of a pulse body.

Headers

Idempotency-Keystring nullable

Response

Successful Response

unknown required

Changes

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