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 jobs
Retrieve all jobs.
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.
Filter by a comma-separated list of job codes.
Filter by the post_url
field. Can be used to find a job based on its public posting URL.
(⚠️ Deprecated - Use the statuses
filter instead.) Filter by the status
field. Can be used to find a job based on its status.
Filter by a comma-separated list of OPEN
, CLOSED
, DRAFT
, ARCHIVED
Leave this blank to get results matching all values.
Filter by a comma-separated list of FULL_TIME
, PART_TIME
, CONTRACT
, SEASONAL
, INTERNSHIP
Leave this blank to get results matching all values.
Filter by a comma-separated list of PUBLIC
, INTERNAL
, UNLISTED
, CONFIDENTIAL
Leave this blank to get results matching all values.
Filter jobs by the day they were created in the remote system. This allows you to get jobs that were created on or after a certain day.
Filter by the name
field. Can be used to find a job by keywords present in the job name.
{
"status": "success",
"data": {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "Backend Engineer",
"job_code": "BE-2021-01",
"description": "<p>Kombo is hiring engineers! If you are reading this and you are located in Berlin, Germany, feel free to contact us about this position.</p>",
"confidential": false,
"weekly_hours": 37,
"employment_type": "FULL_TIME",
"status": "OPEN",
"visibility": "PUBLIC",
"category": "Technical Job",
"department": "Engineering",
"post_url": "https://jobs.example.com/post/159829112",
"experience_level": "Mid-Senior",
"remote_work_status": "HYBRID",
"salary_amount": 4200,
"salary_amount_from": null,
"salary_amount_to": null,
"salary_currency": "EUR",
"salary_period": "MONTH",
"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": [],
"opened_at": "2022-08-07T14:01:29.196Z",
"closed_at": null,
"remote_created_at": "2022-08-07T14:01:29.196Z",
"remote_updated_at": "2022-08-07T14:01:29.196Z",
"contact_id": "6gT2yLMBEipd3zpezATv3Rhu",
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"stages": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "Initial Screening",
"index": 0
}
],
"screening_questions": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
"title": "Which is your primary programming language?",
"description": "Please enter the language you are most comfortable with.",
"format": {
"display_type": "SINGLE_LINE",
"max_length": null,
"type": "TEXT"
},
"index": 0,
"required": true,
"precondition_question_id": "4ZVteCSSgDw3BdwGzcQqGEPk",
"precondition_options": [
"7qd5qjPwDHarsMLFMGzXYG1K"
]
}
],
"job_postings": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
"title": "Frontend Engineer",
"description_html": "<p>We are looking for a Frontend Engineer.</p>",
"status": "ACTIVE",
"visibility": "PUBLIC",
"url": "https://jobs.example.com/post/159829112",
"remote_data": null
}
],
"hiring_team": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@kombo.dev",
"hiring_team_roles": [
"RECRUITER"
]
}
]
}
]
}
}
This feature is currently available for the following integrations:
- Workday
- SAP SuccessFactors
- SmartRecruiters
- Factorial
- Oracle Recruiting Cloud
- Lever
- iCIMS
- Cornerstone TalentLink
- Recruitee
- Greenhouse
- Greenhouse Job Board
- Teamtailor
- Ashby
- CEGID TalentSoft FrontOffice
- CEGID TalentSoft Customer
- concludis
- P&I Loga
- Onlyfy
- Personio
- UKG Pro
- rexx systems
- 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
- Jobylon
- Taleez
- HRworks
- OTYS
- Zoho Recruit
- Eploy
- JobDiva
- CareerPlug
- Paylocity
- Heyrecruit
- RECRU
- JazzHR
- BITE
- Homerun
- Mysolution
- Carerix
- HR Office
- Talent Clue
- InRecruiting
- Ubeeo
- Connexys By Bullhorn
- HR4YOU
- Cornerstone OnDemand
- Zvoove Recruit
- Comeet
- Compleet
- Breezy HR
- Flatchr
- ReachMee
- TalentAdore
- Kombo Sandbox
- GuideCom
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:
- 🔄 Getting updates of the data
- ❗ Handling failing syncs
- 🔍 Letting your customer choose which jobs to expose
- 🔗 Matching jobs in your database to ATS jobs
- 🗑️ Reacting to deleted/closed jobs
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.
Filter by a comma-separated list of job codes.
Filter by the post_url
field. Can be used to find a job based on its public posting URL.
(⚠️ Deprecated - Use the statuses
filter instead.) Filter by the status
field. Can be used to find a job based on its status.
OPEN
, CLOSED
, DRAFT
, ARCHIVED
Filter by a comma-separated list of OPEN
, CLOSED
, DRAFT
, ARCHIVED
Leave this blank to get results matching all values.
Filter by a comma-separated list of FULL_TIME
, PART_TIME
, CONTRACT
, SEASONAL
, INTERNSHIP
Leave this blank to get results matching all values.
Filter by a comma-separated list of PUBLIC
, INTERNAL
, UNLISTED
, CONFIDENTIAL
Leave this blank to get results matching all values.
Filter jobs by the day they were created in the remote system. This allows you to get jobs that were created on or after a certain day.
Filter by the name
field. Can be used to find a job by keywords present in the job name.
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.
Title of the job.
The human readable job code. Some systems expose this as the Requisition Code/ID.
Description of the job. This field is usually returned as HTML.
(⚠️ Deprecated) It makes more sense to store the visibility of a job in an enum. Therefore, we introduced the visibility
enum on jobs.
The number of hours per week an employee is expected to work.
The type of employment contract. In rare cases where can't find a clear mapping, the original string is passed through.
FULL_TIME
, PART_TIME
, CONTRACT
, SEASONAL
, INTERNSHIP
The job’s current status. In rare cases where we can’t find a clear mapping, the original string is passed through.
OPEN
, CLOSED
, DRAFT
, ARCHIVED
Describes the visibility of the job:
PUBLIC
: visible to everyone, published on a job boardINTERNAL
: only visible to employees of the company itselfUNLISTED
: anyone can apply but only if they have the link to itCONFIDENTIAL
: nobody can apply and it's only visible in the ATS to people who were invited to it
In rare cases where we can’t find a clear mapping, the original string is passed through.
PUBLIC
, INTERNAL
, UNLISTED
, CONFIDENTIAL
The category of the job (often the job industry).
The public job posting URL of the ATS itself. This can be used by external job boards to redirect applicants.
Defines if the job supports remote work and if so, to what extent.
REMOTE
, HYBRID
, TEMPORARY
, ON_SITE
The salary amount in the given currency.
The lower bound of the salary range.
The upper bound of the salary range.
Salary currency usually returned in ISO 4217 currency codes.
The period of time over which the salary amount is paid (not equal to the pay frequency). In rare cases where we can’t find a clear mapping, the original string is passed through.
YEAR
, MONTH
, TWO_WEEKS
, WEEK
, DAY
, HOUR
The location of the listed job.
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.
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)
YYYY-MM-DDTHH:mm:ss.sssZ
YYYY-MM-DDTHH:mm:ss.sssZ
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.
(⚠️ Deprecated) The user ID of the contact person for this job. We strongly recommend using the new hiring_team
property instead as it provides more complete and accurate information about the ATS users connected to a job.
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.
Application stages a candidate can be in for this particular 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 application stage name. For example, "Initial Screening".
Numeric index following the order of the stages if they are ordered in the underlying tool.
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.
TEXT
If unavailable, we recommend displaying a single-line input.
SINGLE_LINE
, MULTI_LINE
, EMAIL
, URL
The Kombo ID of another screening question. Only display this question if the specified "precondition question" is answered with one of the values in precondition_options
.
Where the screening question specified by precondition_question_id
is of type MULTI_SELECT
or SINGLE_SELECT
, this is an array of Kombo IDs describing the valid options. If the question is of type BOOLEAN
, this is an array containing either true
or false
.
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 job posting’s title.
The job posting’s description in HTML format.
The job posting’s current status.
ACTIVE
, INACTIVE
, DRAFT
PUBLIC
, INTERNAL
, UNLISTED
The public URL to the job posting on the ATS platform.
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 hiring team allows you to sync users into your system who can access the job and its applications.
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 user.
Last name of the user.
Email of the user. If the email address is invalid, it will be set to null.
Array of the roles of the user for this specific job. Currently only RECRUITER
and HIRING_MANAGER
are mapped into our unified schema.
RECRUITER
, HIRING_MANAGER
{
"status": "success",
"data": {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "Backend Engineer",
"job_code": "BE-2021-01",
"description": "<p>Kombo is hiring engineers! If you are reading this and you are located in Berlin, Germany, feel free to contact us about this position.</p>",
"confidential": false,
"weekly_hours": 37,
"employment_type": "FULL_TIME",
"status": "OPEN",
"visibility": "PUBLIC",
"category": "Technical Job",
"department": "Engineering",
"post_url": "https://jobs.example.com/post/159829112",
"experience_level": "Mid-Senior",
"remote_work_status": "HYBRID",
"salary_amount": 4200,
"salary_amount_from": null,
"salary_amount_to": null,
"salary_currency": "EUR",
"salary_period": "MONTH",
"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": [],
"opened_at": "2022-08-07T14:01:29.196Z",
"closed_at": null,
"remote_created_at": "2022-08-07T14:01:29.196Z",
"remote_updated_at": "2022-08-07T14:01:29.196Z",
"contact_id": "6gT2yLMBEipd3zpezATv3Rhu",
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"stages": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "Initial Screening",
"index": 0
}
],
"screening_questions": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
"title": "Which is your primary programming language?",
"description": "Please enter the language you are most comfortable with.",
"format": {
"display_type": "SINGLE_LINE",
"max_length": null,
"type": "TEXT"
},
"index": 0,
"required": true,
"precondition_question_id": "4ZVteCSSgDw3BdwGzcQqGEPk",
"precondition_options": [
"7qd5qjPwDHarsMLFMGzXYG1K"
]
}
],
"job_postings": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
"title": "Frontend Engineer",
"description_html": "<p>We are looking for a Frontend Engineer.</p>",
"status": "ACTIVE",
"visibility": "PUBLIC",
"url": "https://jobs.example.com/post/159829112",
"remote_data": null
}
],
"hiring_team": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@kombo.dev",
"hiring_team_roles": [
"RECRUITER"
]
}
]
}
]
}
}