get

Search candidates across the agency's hiring pipelines.
Results include each candidate's person, job, and current workflow stage.

Use the structured owner and stage filters for pipeline questions; do not put recruiter names, ownership, job status, or stage labels in the Lucene query.

  • person_owned_by_ids means candidates assigned to those users.
  • job_owned_by_ids means candidates on jobs managed by those users.

If "a recruiter's candidates" is ambiguous, clarify which ownership meaning the user intends, or query both separately and label the results.
Resolve user, workflow-stage, and job-status IDs with their respective list tools, then pass them here.

For example, "who is close to an offer that this recruiter is representing" should use the recruiter's user ID with person_owned_by_ids, active job_status_ids, the relevant final interview/offer workflow_stage_ids, and exclude_rejected: true.

The optional query is only for candidate/person text such as name, title, company, skills, location, or email.
It supports Lucene field-qualified terms, ranges, and boolean operators.
Scroll pagination is supported.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
integer

Number of results to return in each page

string

A cursor used to retrieve the next page of results.
Returned in each response.

string

Search query. Supports Lucene query syntax.

integer
person_owned_by_ids
array of integers

User IDs assigned as owner of the candidate people

person_owned_by_ids
job_owned_by_ids
array of integers

User IDs assigned as owners of the candidate jobs

job_owned_by_ids
workflow_stage_ids
array of integers

Current candidate workflow stage IDs

workflow_stage_ids
job_status_ids
array of integers

Status IDs of jobs containing the candidates

job_status_ids
boolean

Exclude candidates whose current activity is rejected

Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!