Get candidates

Python

from kombo import Kombo


with Kombo(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.ats.get_candidates(page_size=100, include_deleted=False, ignore_unsupported_filters=False)

    while res is not None:
        # Handle items

        res = res.next()

import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28",
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.ats.getCandidates({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

require 'kombo'

Models = ::Kombo::Models
s = ::Kombo::Kombo.new(
  integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28',
  security: Models::Shared::Security.new(
    api_key: '<YOUR_BEARER_TOKEN_HERE>'
  )
)
res = s.ats.get_candidates(page_size: 100, include_deleted: false, ignore_unsupported_filters: false)

unless res.get_ats_candidates_positive_response.nil?
  # handle response
end

const options = {
  method: 'GET',
  headers: {'X-Integration-Id': '<x-integration-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.kombo.dev/v1/ats/candidates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kombo.dev/v1/ats/candidates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Integration-Id: <x-integration-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kombo.dev/v1/ats/candidates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Integration-Id", "<x-integration-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "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_url": "https://app.greenhouse.io/people/32",
        "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": null,
            "rejected_at": null,
            "remote_url": "https://app.greenhouse.io/applications/32",
            "changed_at": "2022-08-07T14:01:29.196Z",
            "remote_created_at": "2022-08-07T14:01:29.196Z",
            "remote_updated_at": "2022-08-07T14:01:29.196Z",
            "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"
          }
        ]
      }
    ]
  }
}

GET

ats

candidates

Python

from kombo import Kombo


with Kombo(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.ats.get_candidates(page_size=100, include_deleted=False, ignore_unsupported_filters=False)

    while res is not None:
        # Handle items

        res = res.next()

import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28",
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.ats.getCandidates({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

require 'kombo'

Models = ::Kombo::Models
s = ::Kombo::Kombo.new(
  integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28',
  security: Models::Shared::Security.new(
    api_key: '<YOUR_BEARER_TOKEN_HERE>'
  )
)
res = s.ats.get_candidates(page_size: 100, include_deleted: false, ignore_unsupported_filters: false)

unless res.get_ats_candidates_positive_response.nil?
  # handle response
end

const options = {
  method: 'GET',
  headers: {'X-Integration-Id': '<x-integration-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.kombo.dev/v1/ats/candidates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kombo.dev/v1/ats/candidates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Integration-Id: <x-integration-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kombo.dev/v1/ats/candidates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Integration-Id", "<x-integration-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "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_url": "https://app.greenhouse.io/people/32",
        "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": null,
            "rejected_at": null,
            "remote_url": "https://app.greenhouse.io/applications/32",
            "changed_at": "2022-08-07T14:01:29.196Z",
            "remote_created_at": "2022-08-07T14:01:29.196Z",
            "remote_updated_at": "2022-08-07T14:01:29.196Z",
            "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"
          }
        ]
      }
    ]
  }
}

Supported integrations

This feature is currently available for the following integrations:

You’d like to see this feature for another integration? Please reach out! We’re always happy to discuss extending our coverage.

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<int64>

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. 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.

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.

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$

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

ignore_unsupported_filters

enum<string>

default:false

When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.

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<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.

Response

GET /ats/candidates Positive response

status

string

required

Allowed value: "success"

data

object

required

Show child attributes

Example:

{
  "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_url": "https://app.greenhouse.io/people/32",
      "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": null,
          "rejected_at": null,
          "remote_url": "https://app.greenhouse.io/applications/32",
          "changed_at": "2022-08-07T14:01:29.196Z",
          "remote_created_at": "2022-08-07T14:01:29.196Z",
          "remote_updated_at": "2022-08-07T14:01:29.196Z",
          "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"
        }
      ]
    }
  ]
}

General

Features

Guides

ATS API Reference

General API Reference

Get candidates

Authorizations

Headers

Query Parameters

Response