Kombo Unified ATS API API
Unified endpoints to access all the ATS concepts you might need.
Kombo Unified ATS API API is one of 8 APIs that Kombo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Unified ATS API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.
This API exposes 30 operations across 25 paths, and defines 149 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.kombo.dev/v1, https://api.us.kombo.dev/v1.
30 operations
25 paths
149 schemas
1 DELETE16 GET1 PATCH11 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Kombo Unified ATS API API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (ApiKey).
By default, every request must be authenticated.
ApiKey— Create an API key on the [Secrets](https://app.kombo.dev/secrets) page in the Kombo dashboard.
Paths & Operations 30
Across 25 paths, the API surfaces 30 operations — 1 DELETE, 16 GET, 1 PATCH, 11 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Unified ATS API 30
Unified endpoints to access all the ATS concepts you might need.
GET
/ats/applications
Get applications
PUT
/ats/applications/{application_id}/stage
Move application to stage
POST
/ats/applications/{application_id}/result-links
Add result link to application
POST
/ats/applications/{application_id}/notes
Add note to application
GET
/ats/applications/{application_id}/attachments
Get application attachments
POST
/ats/applications/{application_id}/attachments
Add attachment to application
POST
/ats/applications/{application_id}/reject
Reject application
POST
/ats/applications/{application_id}/interviews
Create interview
PATCH
/ats/applications/{application_id}/interviews
Update interview
GET
/ats/candidates
Get candidates
POST
/ats/candidates
Create candidate
GET
/ats/candidates/{candidate_id}/attachments
Get candidate attachments
POST
/ats/candidates/{candidate_id}/attachments
Add attachment to candidate
POST
/ats/candidates/{candidate_id}/result-links
Add result link to candidate
POST
/ats/candidates/{candidate_id}/tags
Add tag to candidate
DELETE
/ats/candidates/{candidate_id}/tags
Remove tag from candidate
GET
/ats/tags
Get tags
GET
/ats/application-stages
Get application stages
GET
/ats/jobs
Get jobs
POST
/ats/jobs/{job_id}/applications
Create application
GET
/ats/users
Get users
GET
/ats/roles
Get roles
GET
/ats/offers
Get offers
GET
/ats/rejection-reasons
Get rejection reasons
GET
/ats/interviews
Get interviews
GET
/ats/actions/ats_create_candidate
GET
/ats/actions/ats_create_application
GET
/ats/actions/ats_add_application_attachment
GET
/ats/actions/ats_add_candidate_attachment
POST
/ats/import-tracked-application
Import tracked application
Schemas 149
The contract defines 149 schemas that model the data the API accepts and returns. The most detailed are PostAtsCandidatesRequestBody (8 properties), PostAtsJobsJobIdApplicationsRequestBody (8 properties), PostAtsImportTrackedApplicationRequestBody (7 properties), PatchAtsApplicationsApplicationIdInterviewsRequestBody (7 properties). Each schema is shown below with its type and property counts.
GetAtsRolesParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
GetAtsJobsParameterJobCodes
string
Filter by a comma-separated list of job codes.
GetAtsJobsParameterStatus
string
(⚠️ Deprecated - Use the statuses filter instead.) Filter by the status field. Can be used to find a job based on its status.
GetAtsApplicationsParameterOutcomes
string
Filter by a comma-separated list of PENDING, HIRED, DECLINED PENDING: The application is still being processed. HIRED: The candidate was hired. DECLINED: The c…
GetAtsApplicationsParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
PostAtsApplicationsApplicationIdResultLinksPositiveResponse
object
3 properties
3 required
PatchAtsApplicationsApplicationIdInterviewsParameterApplicationId
string
The ID of the application
GetAtsApplicationsParameterPageSize
integer
The number of results to return per page. Maximum is 250.
GetAtsTagsParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
PostAtsCandidatesCandidateIdTagsRequestBody
object
2 properties
1 required
GetAtsJobsParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
GetAtsRejectionReasonsParameterPageSize
integer
The number of results to return per page. Maximum is 250.
PostAtsJobsJobIdApplicationsPositiveResponse
object
3 properties
3 required
GetAtsTagsParameterUpdatedAfter
string
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 bee…
GetAtsOffersPositiveResponse
object
2 properties
2 required
PatchAtsApplicationsApplicationIdInterviewsPositiveResponse
object
2 properties
2 required
GetAtsJobsParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
GetAtsCandidatesParameterLastName
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 thi…
GetAtsJobsParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
GetAtsApplicationsApplicationIdAttachmentsParameterApplicationId
string
The Kombo ID of the application you want to obtain attachments for.
GetAtsApplicationsParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
GetAtsInterviewsParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
GetAtsUsersParameterUpdatedAfter
string
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 bee…
PutAtsApplicationsApplicationIdStagePositiveResponse
object
3 properties
3 required
GetAtsApplicationsParameterRemoteCreatedAfter
string
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.
PutAtsApplicationsApplicationIdStageParameterApplicationId
string
The Kombo ID of the application you want to move to a different stage.
GetAtsRejectionReasonsParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
GetAtsRejectionReasonsPositiveResponse
object
2 properties
2 required
GetAtsInterviewsParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
PostAtsCandidatesRequestBody
object
8 properties
2 required
GetAtsOffersParameterPageSize
integer
The number of results to return per page. Maximum is 250.
PostAtsApplicationsApplicationIdAttachmentsPositiveResponse
object
3 properties
3 required
PostAtsApplicationsApplicationIdNotesRequestBody
object
3 properties
2 required
GetAtsApplicationsParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
PostAtsImportTrackedApplicationPositiveResponse
object
3 properties
3 required
GetAtsApplicationsApplicationIdAttachmentsPositiveResponse
object
3 properties
3 required
GetAtsApplicationsParameterCurrentStageIds
string
Filter by a comma-separated list of application stage IDs. We will only return applications that are currently in any of the stages.
PostAtsApplicationsApplicationIdNotesPositiveResponse
object
3 properties
3 required
GetAtsApplicationsParameterJobRemoteIds
string
Filter by a comma-separated list of job remote IDs. We will only return applications that are related to any of the jobs.
GetAtsJobsParameterEmploymentTypes
string
Filter by a comma-separated list of FULLTIME, PARTTIME, CONTRACT, SEASONAL, INTERNSHIP Leave this blank to get results matching all values.
GetAtsInterviewsParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
GetAtsTagsPositiveResponse
object
2 properties
2 required
GetAtsApplicationsParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
GetAtsCandidatesCandidateIdAttachmentsParameterCandidateId
string
The Kombo ID of the candidate you want to obtain attachments for.
GetAtsApplicationStagesParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
GetAtsInterviewsParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
GetAtsTagsParameterPageSize
integer
The number of results to return per page. Maximum is 250.
GetAtsCandidatesParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
GetAtsCandidatesParameterPageSize
integer
The number of results to return per page. Maximum is 250.
GetAtsTagsParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
PostAtsCandidatesCandidateIdAttachmentsRequestBody
object
2 properties
1 required
GetAtsJobsPositiveResponse
object
2 properties
2 required
PostAtsApplicationsApplicationIdResultLinksParameterApplicationId
string
The Kombo ID of the application you want to create the link for.
GetAtsUsersParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
GetAtsOffersParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
PostAtsApplicationsApplicationIdRejectParameterApplicationId
string
The Kombo ID of the application you want to reject.
GetAtsCandidatesParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
GetAtsInterviewsParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
GetAtsApplicationStagesParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
PostAtsApplicationsApplicationIdAttachmentsParameterApplicationId
string
GetAtsRolesParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
PostAtsCandidatesCandidateIdResultLinksParameterCandidateId
string
The Kombo ID of the candidate you want to add the result link to.
GetAtsRolesParameterPageSize
integer
The number of results to return per page. Maximum is 250.
GetAtsActionsAtsAddCandidateAttachmentPositiveResponse
object
2 properties
2 required
GetAtsRolesPositiveResponse
object
2 properties
2 required
GetAtsRolesParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
GetAtsRejectionReasonsParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
GetAtsJobsParameterStatuses
string
Filter by a comma-separated list of OPEN, CLOSED, DRAFT, ARCHIVED Leave this blank to get results matching all values.
GetAtsRejectionReasonsParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
PatchAtsApplicationsApplicationIdInterviewsRequestBody
object
7 properties
7 required
PostAtsJobsJobIdApplicationsParameterJobId
string
The Kombo ID or Remote ID of the Job this candidate should apply for. If you want to use the ID of the integrated system (remoteid) you need to prefix the id w…
DeleteAtsCandidatesCandidateIdTagsPositiveResponse
object
3 properties
3 required
GetAtsJobsParameterRemoteCreatedAfter
string
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.
GetAtsInterviewsParameterJobIds
string
Filter by a comma-separated list of job IDs. We will only return interviews for applications associated with any of these jobs.
GetAtsOffersParameterUpdatedAfter
string
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 bee…
GetAtsTagsParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
PostAtsApplicationsApplicationIdInterviewsPositiveResponse
object
2 properties
2 required
GetAtsUsersPositiveResponse
object
2 properties
2 required
GetAtsRolesParameterScopes
string
Filter by a comma-separated list of SYSTEM, JOB SYSTEM: System-wide roles that apply globally (e.g., an "Admin" role). JOB: Job-scoped roles that apply to spec…
DeleteAtsCandidatesCandidateIdTagsParameterCandidateId
string
The Kombo ID of the candidate you want to remove the tag from.
GetAtsCandidatesParameterJobIds
string
Filter by a comma-separated list of job IDs. We will only return candidates that have applied to any of the jobs.
PostAtsApplicationsApplicationIdNotesParameterApplicationId
string
The Kombo ID of the application you want to create the note for.
GetAtsOffersParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
GetAtsApplicationsParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
GetAtsRolesParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
PostAtsCandidatesCandidateIdResultLinksPositiveResponse
object
3 properties
3 required
GetAtsOffersParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
PostAtsJobsJobIdApplicationsRequestBody
object
8 properties
1 required
GetAtsOffersParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
GetAtsApplicationStagesParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
GetAtsCandidatesPositiveResponse
object
2 properties
2 required
GetAtsUsersParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
GetAtsApplicationsParameterJobIds
string
Filter by a comma-separated list of job IDs. We will only return applications that are related to any of the jobs.
PostAtsImportTrackedApplicationRequestBody
object
7 properties
1 required
GetAtsActionsAtsAddApplicationAttachmentPositiveResponse
object
2 properties
2 required
GetAtsCandidatesParameterFirstName
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 t…
PostAtsCandidatesCandidateIdTagsParameterCandidateId
string
The Kombo ID of the candidate you want to add the tag to.
PostAtsCandidatesCandidateIdAttachmentsPositiveResponse
object
3 properties
3 required
GetAtsCandidatesParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
GetAtsApplicationStagesParameterPageSize
integer
The number of results to return per page. Maximum is 250.
PostAtsCandidatesPositiveResponse
object
3 properties
3 required
GetAtsRejectionReasonsParameterUpdatedAfter
string
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 bee…
GetAtsJobsParameterPostUrl
string
Filter by the posturl field. Can be used to find a job based on its public posting URL.
GetAtsCandidatesCandidateIdAttachmentsPositiveResponse
object
3 properties
3 required
GetAtsJobsParameterVisibilities
string
Filter by a comma-separated list of PUBLIC, INTERNAL, UNLISTED, CONFIDENTIAL Leave this blank to get results matching all values.
GetAtsJobsParameterNameContains
string
Filter by the name field. Can be used to find a job by keywords present in the job name.
GetAtsJobsParameterUpdatedAfter
string
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 bee…
GetAtsUsersParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
GetAtsJobsParameterPageSize
integer
The number of results to return per page. Maximum is 250.
GetAtsJobsParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
PostAtsApplicationsApplicationIdInterviewsRequestBody
object
6 properties
6 required
GetAtsCandidatesParameterEmail
string
Filter the candidates based on an email address. When set, returns only the candidates where the given email is in emailaddresses. This filter is case-insensit…
GetAtsCandidatesParameterUpdatedAfter
string
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 bee…
PostAtsCandidatesCandidateIdResultLinksRequestBody
object
4 properties
2 required
GetAtsApplicationsParameterUpdatedAfter
string
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 bee…
GetAtsUsersParameterEmails
string
Filter by a comma-separated list of emails. We will only return users who have any of the emails. The format of the emails is case-insensitive.
PostAtsCandidatesCandidateIdTagsPositiveResponse
object
3 properties
3 required
GetAtsRejectionReasonsParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
GetAtsCandidatesParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
GetAtsApplicationStagesParameterUpdatedAfter
string
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 bee…
GetAtsCandidatesParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
GetAtsUsersParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
GetAtsTagsParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
GetAtsOffersParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
GetAtsApplicationsPositiveResponse
object
2 properties
2 required
GetAtsJobsParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
GetAtsActionsAtsCreateCandidatePositiveResponse
object
2 properties
2 required
GetAtsRejectionReasonsParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
GetAtsInterviewsPositiveResponse
object
2 properties
2 required
PostAtsApplicationsApplicationIdInterviewsParameterApplicationId
string
The ID of the application
PostAtsApplicationsApplicationIdResultLinksRequestBody
object
4 properties
2 required
PostAtsCandidatesCandidateIdAttachmentsParameterCandidateId
string
The Kombo ID of the candidate you want to add the attachment to.
GetAtsApplicationStagesParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
GetAtsInterviewsParameterUpdatedAfter
string
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 bee…
GetAtsInterviewsParameterPageSize
integer
The number of results to return per page. Maximum is 250.
GetAtsApplicationsParameterOutcome
string
(⚠️ Deprecated - Use the outcomes filter instead.) Filter applications by outcome. This allows you to get applications that are for example PENDING, HIRED, or…
DeleteAtsCandidatesCandidateIdTagsRequestBody
object
2 properties
1 required
GetAtsUsersParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
GetAtsUsersParameterPageSize
integer
The number of results to return per page. Maximum is 250.
PostAtsApplicationsApplicationIdRejectPositiveResponse
object
3 properties
3 required
PostAtsApplicationsApplicationIdAttachmentsRequestBody
object
2 properties
1 required
PutAtsApplicationsApplicationIdStageRequestBody
object
2 properties
1 required
GetAtsApplicationStagesPositiveResponse
object
2 properties
2 required
GetAtsRolesParameterUpdatedAfter
string
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 bee…
GetAtsRolesParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
PostAtsApplicationsApplicationIdRejectRequestBody
object
3 properties
1 required
GetAtsApplicationStagesParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
GetAtsActionsAtsCreateApplicationPositiveResponse
object
2 properties
2 required
GetAtsTagsParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kombo 7
Other APIs Kombo publishes across the network.
Kombo AI Apply API
Kombo Custom Endpoints API
Kombo General API
Kombo Kombo Connect API
Kombo Unified ATS (Assessment & Background Check) API API
Kombo Unified HRIS API API
Kombo Unified LMS API API
#Unified ATS API