Get candidates

GET

ats

candidates

{
  "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": "26vafvWSRmbhNcxJYqjCzuJg",
            "remote_id": "32",
            "outcome": "HIRED",
            "rejection_reason_name": "Any text string",
            "current_stage": {
              "id": "26vafvWSRmbhNcxJYqjCzuJg",
              "name": "Initial Screening",
              "remote_id": "32",
              "index": 2
            },
            "job": {
              "id": "26vafvWSRmbhNcxJYqjCzuJg",
              "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

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.

string

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

data

object

required

data.next

string | null

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.

data.results

object[]

required

data.results.applications

object[]

required

data.results.applications.current_stage

object | null

required

data.results.applications.id

string

required

The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.

data.results.applications.job

object | null

required

data.results.applications.outcome

enum<string> | null

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.

Available options:

PENDING,

HIRED,

DECLINED

data.results.applications.rejection_reason_name

string | null

required

Reason for the rejection of the candidate.

data.results.applications.remote_id

string | null

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.

data.results.changed_at

string

required

The timestamp when this object was last changed. This value is tracked by Kombo based on changes in the data.

data.results.company

string | null

required

The current company of the candidate.

data.results.confidential

boolean | null

required

Whether the candidate’s profile is confidential in the ATS.

data.results.custom_fields

object | null

required

A key-value store of fields not covered by the schema. Read more

data.results.first_name

string | null

required

First name of the candidate.

data.results.id

string

required

The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.

data.results.integration_fields

object[]

required

An array of selected pass-through integration fields. Read more

data.results.last_name

string | null

required

Last name of the candidate.

data.results.remote_created_at

string | null

required

The date and time the object was created in the remote system.

data.results.remote_data

object | null

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.

data.results.remote_deleted_at

string | null

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.

data.results.remote_id

string

required

data.results.remote_updated_at

string | null

required

A timestamp retrieved from the remote system, describing when the resource was last updated.

data.results.source

string | null

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.

data.results.tags

object[]

required

data.results.title

string | null

required

The current job title of the candidate.

data.results.email_addresses

object[] | null

A list of email addresses of the candidate with an optional type. If an email address is invalid, it will be filtered out.

data.results.location

object | null

Location of the candidate.

data.results.phone_numbers

object[] | null

A list of phone numbers of the candidate.

List of social media accounts of the candidate.

status

enum<string>

required

Available options:

success

Reject application Create candidate

{
  "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": "26vafvWSRmbhNcxJYqjCzuJg",
            "remote_id": "32",
            "outcome": "HIRED",
            "rejection_reason_name": "Any text string",
            "current_stage": {
              "id": "26vafvWSRmbhNcxJYqjCzuJg",
              "name": "Initial Screening",
              "remote_id": "32",
              "index": 2
            },
            "job": {
              "id": "26vafvWSRmbhNcxJYqjCzuJg",
              "name": "Backend Engineer",
              "remote_id": "32"
            }
          }
        ],
        "tags": [
          {
            "id": "26vafvWSRmbhNcxJYqjCzuJg",
            "name": "High Potential",
            "remote_id": "32"
          }
        ]
      }
    ]
  }
}

General

Features

Guides

ATS API Reference

General API Reference

Get candidates

Authorizations

Headers

Query Parameters

Response