GET /v1/jobs/{jobId}/candidates
Read a job's study candidates
Auth: required. Send an
ivy_ API key (Authorization: Bearer ivy_… or X-Ivy-Api-Key), a Clerk session JWT (Authorization: Bearer …) or the Clerk __session cookie (browser sessions). See Authentication.Lists the study candidates recorded for a job you can read, newest first. Send Accept: application/json (or ?json=true) to get JSON; any other request gets the same data as a formatted HTML page. The X-Items-Count header carries the number of items.
With a project-scoped API key, a job outside the key's projects returns 403.
Request
Path parameters
jobIdstring (uuid)
Job UUID.
Query parameters
jsonstring
Set to true to get JSON without sending an Accept header.
Responses
200 OK
The job's candidates
Response shape:
itemsobject[]
Newest first
400 Bad Request
The job id is empty
Response shape: object
401 Unauthorized
Authentication required
Response shape: object
403 Forbidden
You cannot read the job, or it is outside your API key's project scope. The job's existence is not distinguished from either case.
Response shape: object
429 Too Many Requests
Rate limit exceeded
Response shape: object
500 Internal Server Error
Reading candidates failed
Response shape: object
Was this page helpful?