Get a candidate

get

https://api.join.com/v3/candidates/{id}

Returns one candidate by their ID within your company, in the same shape as an item in the candidate list. Their consent status comes from JOIN’s consent record; when no record exists, the status is PENDING.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The candidate

400The Join-Version header names a version this API does not serve.

401Authentication failed. Either the Authorization: Bearer header is missing (authentication_required), or the presented token is malformed, unknown, revoked, or belongs to a company that no longer has API access (token_invalid).

404No candidate with this id exists within the caller’s company. IDs belonging to other companies or to deleted candidates are reported the same way.

422A path parameter, query parameter or body field failed schema validation.

429The token exceeded its sustained (600/60s) or burst (100/10s) request quota. Retry after the number of seconds in Retry-After.

500An unexpected error occurred on JOIN’s side. For a write, the outcome may be uncertain: read the affected record before retrying. See Responses, errors and retries.