Get one role
get_roleOne open role's detail, addressed by the company_id + req_key
pair every search_jobs row already carries -- the follow-up call
for a role you hold an identifier for, instead of re-pulling the whole
company with get_open_reqs. Scoped exactly as search_jobs is:
ATS-only and freshness-floored. The body adds raw_title (the
posting's own title) and boards, the full deduped list of boards
reporting this req. A role that does not exist, is closed, or has not
reached the freshness floor is an explicit error, never an empty
success -- and it is not billed. No key yet? On the hosted HTTP
endpoint the first calls are free: send no X-API-Key header and
the lookup runs on a shared demo credential, billed to
nobody and marked as such, until a per-IP limit is reached.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| req_key | Yes | ||
| company_id | Yes | ||
| plane_api_key | No | Deprecated: pass the key in the `X-API-Key` header, or omit the header for demo mode. Removed in 1.2. | |
| idempotency_key | No |