---
title: "Get candidates"
method: GET
path: "/ats/candidates"
tags: ["Unified ATS API"]
---

# Get candidates

`GET /ats/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)`

## Query parameters

- `cursor` string — An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response.
- `page_size` integer — The number of results to return per page. Maximum is 250.
- `updated_after` string, date-time — Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged. If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden. For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior). For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. | Path | Added/Removed | Linked Record | | --- | --- | --- | | `applications` | ✓ Yes | ✓ Yes | | `applications` → `current_stage` | ✗ No | ✗ No | | `applications` → `job` | ✗ No | ✗ No | | `tags` | ✓ Yes | ✗ No | _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._
- `include_deleted` 'true' | 'false' — By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.
- `ignore_unsupported_filters` 'true' | 'false' — When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
- `ids` string — Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`.
- `remote_ids` string — Filter by a comma-separated list of remote IDs.
- `email` string, email — 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.
- `job_ids` string — Filter by a comma-separated list of job IDs. We will only return candidates that have applied to _any_ of the jobs.
- `first_name` string — 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.
- `last_name` string — 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.

## Headers

- `X-Integration-Id` string, required

## Response `200`

GET /ats/candidates Positive response

- GetAtsCandidatesPositiveResponse
  - `status` 'success', required
  - `data` object, required
    - `next` string, nullable, required — Cursor string that can be passed to the `cursor` query parameter to get the next page. If this is `null`, then there are no more pages.
    - `results` object[], required
      - `id` string, required — The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
      - `remote_id` string, required — The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.
      - `first_name` string, nullable, required — First name of the candidate.
      - `last_name` string, nullable, required — Last name of the candidate.
      - `company` string, nullable, required — The current company of the candidate.
      - `title` string, nullable, required — The current job title of the candidate.
      - `confidential` boolean, nullable, required — Whether the candidate’s profile is confidential in the ATS.
      - `source` string, nullable, required — The hiring source of the candidate. If you're a job board or recruiting service, you can use this to validate which candidates applied through your service and ensure that the correct referral compensation is paid out.
      - `phone_numbers` object[], nullable — A list of phone numbers of the candidate.
        - `phone_number` string, required
        - `type` string, nullable — Kombo exposes type information through this field. If we don't get any information from the tool, we will set this to `null`.
      - `email_addresses` object[], nullable — A list of email addresses of the candidate with an optional type. If an email address is invalid, it will be filtered out.
        - `email_address` string, nullable
        - `type` string, nullable, required — Kombo exposes type information through this field. If we don't get any information from the tool, we will set this to `null`.
      - `social_media` object[], nullable — List of social media accounts of the candidate.
        - `link` string, nullable
        - `type` string, nullable
        - `username` string, nullable
      - `location` object, nullable — Location of the candidate.
        - `city` string, nullable
        - `country` string, nullable — Contains the ISO2 country code if possible. If not, it contains the original value.
        - `raw` string, nullable — If we have address data, this is filled with the raw address string.
        - `state` string, nullable
        - `street_1` string, nullable — If we can parse the address data, this field contains the first part of the street information.
        - `street_2` string, nullable
        - `zip_code` string, nullable
      - `custom_fields` object, nullable, required — A key-value store of fields not covered by the schema. [Read more](/custom-fields)
      - `integration_fields` object[], required — An array of selected passthrough integration fields. [Read more](/integration-fields)
        - `id` string, required — The globally unique ID of this object.
        - `key` string, required — The key of the field in the remote system.
        - `type` 'DEFAULT' | 'CUSTOM', required — - `DEFAULT`: static fields in the remote system. - `CUSTOM`: fields that are created/editable by the user.
        - `value` unknown
        - `label` string, nullable, required — The label of the field. (not always available)
      - `remote_url` string, uri, nullable, required — URL to the candidate profile in the source ATS system. When embedding this in your system, please consider that not for all ATS a dedicated candidate profile URL is available, so you might need to fall back to the application URL.
      - `remote_created_at` string, date-time, nullable, required — The date and time the object was created in the remote system.
      - `remote_updated_at` string, date-time, nullable, required — A timestamp retrieved from the remote system, describing when the resource was last updated.
      - `remote_data` object, nullable, required — Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set. Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: `{ "/companies": { ... }}` This is not available on all plans. Reach out to Kombo if you need it.
      - `changed_at` string, date-time, required — The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated.
      - `remote_deleted_at` string, date-time, nullable, required — The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.
      - `applications` object[], required
        - `id` string, required — The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
        - `remote_id` string, nullable, required — The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.
        - `outcome` 'PENDING' | 'HIRED' | 'DECLINED', nullable, required — Parsed status of the application. If Kombo identifies that the application was accepted and the candidate hired, it will be `HIRED`. If the application was rejected or the candidate declined, it will be `DECLINED`. If the application is still in process, it will be `PENDING`. Kombo will always try to deliver this information as reliably as possible.
        - `rejection_reason_name` string, nullable, required — Reason for the rejection of the candidate.
        - `rejected_at` string, date-time, nullable, required — The time that the application was rejected.
        - `remote_url` string, uri, nullable, required — URL to the application in the source ATS system. When embedding this in your system, please consider that not for all ATS a dedicated application URL is available, so you might need to fall back to the candidate URL.
        - `changed_at` string, date-time, required — The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated.
        - `remote_created_at` string, date-time, nullable, required — The date and time the object was created in the remote system.
        - `remote_updated_at` string, date-time, nullable, required — A timestamp retrieved from the remote system, describing when the resource was last updated.
        - `current_stage` object, nullable, required
          - `id` string, required — The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
          - `name` string, nullable, required — The application stage name. For example, "Initial Screening".
          - `remote_id` string, nullable, required — The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.
          - `index` integer, nullable, required
        - `job` object, nullable, required
          - `id` string, required — The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
          - `name` string, nullable, required — Title of the job.
          - `remote_id` string, required — The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.
      - `tags` object[], required
        - `id` string, required — The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
        - `name` string, nullable, required
        - `remote_id` string, nullable, required — The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.

## Other responses

- `default` — The standard error response with the error codes for the ATS use case.

---

[API](https://skmtc.net/kombo/apis/kombo-api.md) · [All operations](https://skmtc.net/kombo/apis/kombo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kombo/kombo-api/revisions/0cfc9fa971c0/schema)