GET
/
ats
/
candidates
Get candidates
curl --request GET \
  --url https://api.kombo.dev/v1/ats/candidates \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Integration-Id: <x-integration-id>'
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32",
        "first_name": "John",
        "last_name": "Doe",
        "company": "Acme, Inc.",
        "title": "Head of Marketing",
        "confidential": false,
        "source": "Employee Referral",
        "phone_numbers": [
          {
            "phone_number": "+1-541-754-3010",
            "type": "HOME"
          }
        ],
        "email_addresses": [
          {
            "email_address": "john.doe@example.com",
            "type": "PRIVATE"
          }
        ],
        "social_media": [
          {
            "link": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
            "type": "YOUTUBE",
            "username": null
          }
        ],
        "location": {
          "city": "Berlin",
          "country": "DE",
          "raw": "Berlin, Germany",
          "state": "Berlin",
          "street_1": "Lohmühlenstraße 65",
          "street_2": null,
          "zip_code": "12435"
        },
        "custom_fields": {},
        "integration_fields": [],
        "remote_created_at": "2022-04-02T00:00:00.000Z",
        "remote_updated_at": "2022-04-04T00:00:00.000Z",
        "remote_data": null,
        "changed_at": "2022-04-04T00:00:00.000Z",
        "remote_deleted_at": null,
        "applications": [
          {
            "id": "H77fDF8uvEzGNPRubiz5DvQ7",
            "remote_id": "32",
            "outcome": "HIRED",
            "rejection_reason_name": "Any text string",
            "current_stage": {
              "id": "5J7L4b48wBfffYwek9Az9pkM",
              "name": "Initial Screening",
              "remote_id": "32",
              "index": 2
            },
            "job": {
              "id": "H5daSm8e85Dmvmne3wLeCPhX",
              "name": "Backend Engineer",
              "remote_id": "32"
            }
          }
        ],
        "tags": [
          {
            "id": "26vafvWSRmbhNcxJYqjCzuJg",
            "name": "High Potential",
            "remote_id": "32"
          }
        ]
      }
    ]
  }
}
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

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

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
default:100

The number of results to return per page. Maximum is 250.

Required range: 1 <= x <= 250
​
updated_after
string<date-time>

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.

​
include_deleted
enum<string>
default:false

By default, deleted entries are not returned. Use the include_deleted query param to include deleted entries too.

Available options:
true,
false
​
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.

Response

200
application/json

GET /ats/candidates Positive response

The response is of type object.