Retrieve all candidates.
Supported integrations
(id IN ids) AND (remote_id IN remote_ids)
ID of the integration you want to interact with.
An optional cursor string used for pagination. This can be retrieved from the next
property of the previous page response.
The number of results to return per page. Maximum is 250.
1 <= x <= 250
Filter the entries based on the modification date in format YYYY-MM-DDTHH:mm:ss.sssZ. If you want to track entry deletion, also set the include_deleted=true
query parameter, because otherwise, deleted entries will be hidden.
By default, deleted entries are not returned. Use the include_deleted
query param to include deleted entries too.
true
, false
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3
.
Filter by a comma-separated list of remote IDs.
Filter the candidates based on an email address. When set, returns only the candidates where the given email
is in email_addresses
. This filter is case-insensitive.
Filter by a comma-separated list of job IDs. We will only return candidates that have applied to any of the jobs.
Filter candidates by first name. This filter is case-insensitive and matches the exact first name. Fuzzy matching might be enabled in the future, so consider this for your implementation.
Filter candidates by last name. This filter is case-insensitive and matches the exact last name. Fuzzy matching might be enabled in the future, so consider this for your implementation.
GET /ats/candidates Positive response
The response is of type object
.