/company/{id}/position/{id}/candidates/bulk

Reads up to 50 candidates on a position in one request, each with any of their questionnaires, documents, scorecards, conversation, custom fields and activity stream. This is a read: nothing is changed. Use it in place of one GET /candidate/{candidateId} call plus one call per extra for each candidate.

Send exactly one of:

  • candidate_ids: 1 to 50 candidate ids on this position. Ids that aren't on the position are listed in not_found.
  • stage_id: every candidate currently in that pipeline stage, most recently updated first, one page at a time with page (0-based) and page_size (up to 50). Use the stage id values from GET /company/{companyId}/pipeline/{pipelineId}. Read the next page until a page returns fewer than page_size candidates.

Each candidate has the same fields as GET /candidate/{candidateId}, and each extra has the same fields as its own endpoint, with these limits per candidate: 10 questionnaires, 20 documents, the first page of 50 conversation messages and the first page of 50 stream events.

The same permissions apply as when each candidate is read on its own. A candidate the caller can't see (in a restricted stage, or private) is listed in denied with the reason instead of failing the request. An extra the caller isn't allowed to read comes back as an empty array, and without permission to see the team's scorecards only the caller's own are returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params
candidate_ids
array of strings
length between 1 and 50

Candidate ids on this position. Send this or stage_id, not both.

candidate_ids
string
^[A-Za-z0-9_-]{1,64}$

Pipeline stage id. Built-in stages are strings such as applied or hired, custom stages are numeric ids sent as strings. Send this or candidate_ids, not both.

integer
≥ 0
Defaults to 0

With stage_id, the page to return, counting from 0.

integer
1 to 50
Defaults to 50

With stage_id, candidates per page.

include
array of strings

Extras to return with each candidate. Omit for the candidate records only.

include
Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json