General
- Introduction
- Getting started
- Implementation guide
- FAQ
Features
Guides
ATS API Reference
- Jobs
- Applications
- Candidates
- Tags
- Users
- Offers
- Rejection reasons
General API Reference
- Kombo Connect
- Integrations
- Filtering
- Custom Fields
- Other
Get applications
Retrieve all applications.
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. Maximum is 250.
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 don't exist, the endpoint will return a 404 error.
Filter by a comma-separated list of remote IDs.
(⚠️ Deprecated - Use the outcomes
filter instead.) Filter applications by outcome. This allows you to get applications that are for example PENDING
, HIRED
, or DECLINED
.
Filter by a comma-separated list of PENDING
, HIRED
, DECLINED
PENDING
: The application is still being processed.HIRED
: The candidate was hired.DECLINED
: The candidate was declined.
Leave this blank to get results matching all values.
Filter by a comma-separated list of job IDs. We will only return applications that are related to any of the jobs.
Filter by a comma-separated list of job remote IDs. We will only return applications that are related to any of the jobs.
Filter applications by the day they were created in the remote system. This allows you to get applications that were created on or after a certain day.
{
"status": "success",
"data": {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"outcome": "HIRED",
"rejection_reason_name": "Any text string",
"current_stage_id": "5J7L4b48wBfffYwek9Az9pkM",
"job_id": "H5daSm8e85Dmvmne3wLeCPhX",
"candidate_id": "H77fDF8uvEzGNPRubiz5DvQ7",
"screening_question_answers": [
{
"answer": {
"choice": "TypeScript"
},
"question": {
"remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
"title": "Which is your primary programming language",
"type": "SINGLE_SELECT"
}
}
],
"custom_fields": {},
"integration_fields": [],
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_created_at": "2022-08-07T14:01:29.196Z",
"remote_updated_at": "2022-08-07T14:01:29.196Z",
"remote_data": null,
"candidate": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email_addresses": [
{
"email_address": "john.doe@example.com",
"type": "PRIVATE"
}
],
"source": "Employee Referral",
"tags": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "High Potential"
}
]
},
"current_stage": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "Initial Screening",
"index": 2
},
"job": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "Backend Engineer"
},
"interviews": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"title": "Interview with John Doe",
"starting_at": "2023-06-26T14:30:00.000Z",
"ending_at": "2023-06-26T15:30:00.000Z",
"location": {
"city": "Berlin",
"country": "DE",
"raw": "Berlin, Germany",
"state": "Berlin",
"street_1": "Lohmühlenstraße 65",
"street_2": null,
"zip_code": "12435"
}
}
],
"offers": [
{
"id": "76bab8LKuFtqpZ89mofCPMHX",
"remote_id": "6",
"status": "ACCEPTED"
}
]
}
]
}
}
This feature is currently available for the following integrations:
- Workday
- SAP SuccessFactors
- SmartRecruiters
- Oracle Recruiting Cloud
- Lever
- iCIMS
- Cornerstone TalentLink
- Recruitee
- Greenhouse
- Teamtailor
- Ashby
- CEGID TalentSoft FrontOffice
- CEGID TalentSoft Customer
- Onlyfy
- UKG Pro
- AFAS Software
- BambooHR
- Bullhorn
- Bullhorn Login
- Workable
- Jobvite
- Fountain
- Softgarden
- Pinpoint
- Welcome to the Jungle
- d.vinci
- JOIN
- Sage HR
- TRAFFIT
- eRecruiter
- Abacus Umantis
- Haufe Umantis
- Taleez
- HRworks
- OTYS
- Zoho Recruit
- Eploy
- JobDiva
- CareerPlug
- RECRU
- JazzHR
- BITE
- Homerun
- Carerix
- InRecruiting
- Connexys By Bullhorn
- HR4YOU
- Cornerstone OnDemand
- Zvoove Recruit
- Comeet
- Compleet
- Breezy HR
- Flatchr
- ReachMee
- Kombo Sandbox
You’d like to see this feature for another integration? Please reach out! We’re always happy to discuss extending our coverage.
Visit our in depth guide to learn more about:
- 💡 Being aware of which applications are tracked
- 🚦 Hiring signals
- 📈 Application stage changes
- ❓ ATS-specific limitations
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
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. Maximum is 250.
1 < x < 250
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 don't exist, the endpoint will return a 404 error.
Filter by a comma-separated list of remote IDs.
(⚠️ Deprecated - Use the outcomes
filter instead.) Filter applications by outcome. This allows you to get applications that are for example PENDING
, HIRED
, or DECLINED
.
PENDING
, HIRED
, DECLINED
Filter by a comma-separated list of PENDING
, HIRED
, DECLINED
PENDING
: The application is still being processed.HIRED
: The candidate was hired.DECLINED
: The candidate was declined.
Leave this blank to get results matching all values.
Filter by a comma-separated list of job IDs. We will only return applications that are related to any of the jobs.
Filter by a comma-separated list of job remote IDs. We will only return applications that are related to any of the jobs.
Filter applications by the day they were created in the remote system. This allows you to get applications that were created on or after a certain day.
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.
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.
ID of the current application stage
The Kombo ID of the job which the candidate applied to. The ID can be used to retrieve the job from the get jobs
endpoint.
The Kombo ID of the candidate who applied to the job. The ID can be used to retrieve the candidate from the get candidates
endpoint.
An array of selected pass-through integration fields. Read more
The globally unique ID of this object.
The key of the field in the remote system.
DEFAULT
: static fields in the remote system.CUSTOM
: fields that are created/editable by the user.
DEFAULT
, CUSTOM
The field's value.
The label of the field. (not always available)
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 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 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 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.
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.
A list of email addresses of the candidate with an optional type. If an email address is invalid, it will be filtered out.
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.
The application stage name. For example, "Initial Screening".
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.
Title of the job.
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.
The title of the interview.
The start time of the interview.
The end time of the interview.
Location of the interview.
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.
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.
The offer’s current status. The usual flow of statuses is as follows:
DRAFT
-> APPROVED
-> SENT
-> ACCEPTED
or DECLINED
.
Please note that not all systems will expose all statuses. For example, most systems do not include the APPROVED
status
ACCEPTED
: The offer was accepted by the candidate.DECLINED
: The offer was declined by the candidate.SENT
: The offer was sent to the candidate.APPROVED
: The draft was approved.DRAFT
: The offer is a draft and has not yet been sent to the candidate.ABANDONED
: The offer has expired or is no longer valid and should not be considered.
ACCEPTED
, DECLINED
, SENT
, APPROVED
, DRAFT
, ABANDONED
{
"status": "success",
"data": {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"outcome": "HIRED",
"rejection_reason_name": "Any text string",
"current_stage_id": "5J7L4b48wBfffYwek9Az9pkM",
"job_id": "H5daSm8e85Dmvmne3wLeCPhX",
"candidate_id": "H77fDF8uvEzGNPRubiz5DvQ7",
"screening_question_answers": [
{
"answer": {
"choice": "TypeScript"
},
"question": {
"remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
"title": "Which is your primary programming language",
"type": "SINGLE_SELECT"
}
}
],
"custom_fields": {},
"integration_fields": [],
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_created_at": "2022-08-07T14:01:29.196Z",
"remote_updated_at": "2022-08-07T14:01:29.196Z",
"remote_data": null,
"candidate": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email_addresses": [
{
"email_address": "john.doe@example.com",
"type": "PRIVATE"
}
],
"source": "Employee Referral",
"tags": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "High Potential"
}
]
},
"current_stage": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "Initial Screening",
"index": 2
},
"job": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "Backend Engineer"
},
"interviews": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"title": "Interview with John Doe",
"starting_at": "2023-06-26T14:30:00.000Z",
"ending_at": "2023-06-26T15:30:00.000Z",
"location": {
"city": "Berlin",
"country": "DE",
"raw": "Berlin, Germany",
"state": "Berlin",
"street_1": "Lohmühlenstraße 65",
"street_2": null,
"zip_code": "12435"
}
}
],
"offers": [
{
"id": "76bab8LKuFtqpZ89mofCPMHX",
"remote_id": "6",
"status": "ACCEPTED"
}
]
}
]
}
}