Get candidates
Retrieve all candidates.
Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: (id IN ids) AND (remote_id IN remote_ids)
Authorizations
Create an API key on the Secrets page in the Kombo dashboard.
Headers
ID of the integration you want to interact with.
Query Parameters
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.
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
. Those IDs are validated to be 24 characters long and to exist for this integration in the database. If any of the IDs don't exist, the endpoint will return a 404 error.
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
.
Filter by a comma-separated list of job IDs. We will only return candidates that have applied to any of the jobs.
Response
success