- Documentation
- HRIS API
- ATS API
- ATS-Assessment API
- Status
Kombo Connect
Filtering
Integrations
Other
Jobs
Applications
Candidates
Tags
Users
General API Reference
ATS API Reference
Get candidates
Retrieve all candidates.
Create an API key on the Secrets page in the Kombo dashboard.
ID of the integration you want to interact with.
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.
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 are 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.
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": {},
"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"
},
"job": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "Backend Engineer",
"remote_id": "32"
}
}
],
"tags": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "High Potential",
"remote_id": "32"
}
]
}
]
}
}This feature is currently available for the following integrations:
Workday
SAP SuccessFactors
SmartRecruiters
Oracle Recruiting Cloud
Lever
iCIMS
Cornerstone TalentLink
Recruitee
Greenhouse
Teamtailor
Ashby
TalentSoft Customer
Onlyfy
AFAS Software
BambooHR
Bullhorn
Bullhorn Login
Workable
Jobvite
Fountain
Pinpoint
Welcome to the Jungle
JOIN
Sage HR
TRAFFIT
Haufe Umantis
Taleez
HRworks
OTYS
Eploy
RECRU
JazzHR
BITE
Homerun
Carerix
Breezy HR
Flatchr
ApplicantStack
Kombo Sandbox
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
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 are 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 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.
The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
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 of the candidate.
Last name of the candidate.
The current company of the candidate.
The current job title of the candidate.
Whether the candidate’s profile is confidential in the ATS.
The name of who reffered 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.
A list of phone numbers of the candidate.
Kombo exposes type information through this field. If we don't get any information from the tool, we will set this to null.
A list of email addresses of the candidate with an optional type. If an email address is invalid, it will be filtered out.
Kombo exposes type information through this field. If we don't get any information from the tool, we will set this to null.
List of social media accounts of the candidate.
Location of the candidate.
Contains the ISO2 country code if possible. If not, it contains the original value.
If we have address data, this is filled with the raw address string.
If we can parse the address data, this field contains the first part of the street information.
A key-value store of fields not covered by the schema. Read more
The date and time the object was created in the remote system.
A timestamp retrieved from the remote system, describing when the resource was last updated.
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.
The timestamp when this object was last changed. This value is tracked by Kombo based on changes in the data.
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.
The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
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.
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.
PENDING, HIRED, DECLINED Reason for the rejection of the candidate.
The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
The application stage name. For example, "Initial Screening".
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.
The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
Title of the job.
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.
The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
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.
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": {},
"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"
},
"job": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "Backend Engineer",
"remote_id": "32"
}
}
],
"tags": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "High Potential",
"remote_id": "32"
}
]
}
]
}
}