Skip to main content
GET
List candidates

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:25

Page size. Defaults to 25. Maximum 100.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor returned by the previous page.

job_id
integer

Filter by numeric job id.

Required range: x >= 1
email
string<email>

Filter by normalized candidate email.

stage
enum<string>

Filter by stage. Candidate pipeline stages currently accepted by the public API.

Available options:
prospect,
applied,
phonescreen,
inprogress,
hired,
rejected
created_after
string<date-time>

ISO8601 timestamp lower bound for created_at.

created_before
string<date-time>

ISO8601 timestamp exclusive upper bound for created_at.

updated_after
string<date-time>

ISO8601 timestamp lower bound for updated_at.

sort
enum<string>
default:created_at

Sort field.

Available options:
created_at,
updated_at,
name
order
enum<string>
default:desc

Sort order.

Available options:
asc,
desc

Response

Candidates list

Candidate list response with pagination metadata.

data
object[]
required
pagination
object
required

Cursor pagination metadata returned by list endpoints.