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.

cursorstring

Opaque pagination cursor from the previous page's pagination.next_cursor, bound to the same query filters.

limitinteger

Page size. Must be between 1 and 100; defaults to 25.

idsstring[] nullable

Comma-separated list of IDs; maximum 100 values.

[
  "can_a1b2c3d4e5f64789a1b2c3d4e5f64789"
]

emailstring

Case-insensitive exact match on candidate email; combines with other filters using AND.

namestring

Case-insensitive substring match on candidate name; combines with other filters using AND.

ats_idsstring[] nullable

Matches candidates whose ATS ID is one of these exact values; combines with other filters using AND.

Filters by ATS provider.

created_at_gtestring date-time

Filters records created at or after this timestamp.

created_at_ltestring date-time

Filters records created at or before this timestamp.

updated_at_gtestring date-time

Filters records updated at or after this timestamp.

updated_at_ltestring date-time

Filters records updated at or before this timestamp.

Response

Success

Example response

{
  "data": [
    {
      "id": "can_a1b2c3d4e5f64789a1b2c3d4e5f64789",
      "recruiter": {
        "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
      },
      "coordinator": {
        "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
      }
    }
  ]
}

v1

List candidates

Query parameters

Response

Example response