List candidates
Returns paginated candidate summaries with contact details, hiring-team assignments, ATS metadata, and anonymization state. Combine IDs, email, name, ATS, and record-timestamp filters to narrow results; every supplied filter is applied together. Anonymized candidates return redacted PII, and the returned cursor continues the same filtered result set.
Authorizations
API tokens are passed as Bearer tokens.
Query Parameters
Opaque pagination cursor from the previous page's pagination.next_cursor, bound to the same query filters.
Page size. Must be between 1 and 100; defaults to 25.
1 <= x <= 100Comma-separated list of IDs; maximum 100 values.
a candidate ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.
^(?:can_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$Case-insensitive exact match on candidate email; combines with other filters using AND.
Case-insensitive substring match on candidate name; combines with other filters using AND.
Matches candidates whose ATS ID is one of these exact values; combines with other filters using AND.
Filters by ATS provider.
GREENHOUSE, ASHBY, LEVER, WORKDAY, SMARTRECRUITERS, GEM, KOMBO Filters records created at or after this timestamp.
Filters records created at or before this timestamp.
Filters records updated at or after this timestamp.
Filters records updated at or before this timestamp.