The identity and technical contract details declared by the specification.
GetAtsJobsParameterPostUrl
string
Filter by the posturl field. Can be used to find a job based on its public posting URL.
PostAtsApplicationsApplicationIdRejectPositiveResponse
object
3 properties
3 required
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…
PutAtsApplicationsApplicationIdStageParameterApplicationId
string
The Kombo ID of the application you want to move to a different stage.
PostAtsApplicationsApplicationIdResultLinksPositiveResponse
object
3 properties
3 required
PostAtsCandidatesCandidateIdAttachmentsRequestBody
object
2 properties
1 required
PostAtsCandidatesCandidateIdAttachmentsParameterCandidateId
string
The Kombo ID of the candidate you want to add the attachment to.
GetAtsInterviewsParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
GetAtsJobsParameterStatuses
string
Filter by a comma-separated list of OPEN, CLOSED, DRAFT, ARCHIVED Leave this blank to get results matching all values.
GetAtsApplicationStagesParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
GetAtsApplicationsParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
GetAtsOffersPositiveResponse
object
2 properties
2 required
GetAtsUsersPositiveResponse
object
2 properties
2 required
GetAtsRejectionReasonsParameterPageSize
integer
The number of results to return per page. Maximum is 250.
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…
GetAtsActionsAtsCreateCandidatePositiveResponse
object
2 properties
2 required
GetAtsInterviewsParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
PostAtsCandidatesCandidateIdTagsParameterCandidateId
string
The Kombo ID of the candidate you want to add the tag to.
PostAtsCandidatesCandidateIdResultLinksRequestBody
object
4 properties
2 required
GetAtsApplicationsApplicationIdAttachmentsPositiveResponse
object
3 properties
3 required
GetAtsCandidatesParameterPageSize
integer
The number of results to return per page. Maximum is 250.
GetAtsApplicationsParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
GetAtsInterviewsPositiveResponse
object
2 properties
2 required
GetAtsInterviewsParameterJobIds
string
Filter by a comma-separated list of job IDs. We will only return interviews for applications associated with any of these jobs.
GetAtsOffersParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
GetAtsApplicationsPositiveResponse
object
2 properties
2 required
GetAtsApplicationsParameterJobIds
string
Filter by a comma-separated list of job IDs. We will only return applications that are related to any of the jobs.
DeleteAtsCandidatesCandidateIdTagsRequestBody
object
2 properties
1 required
GetAtsUsersParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
PostAtsCandidatesRequestBody
object
8 properties
2 required
PostAtsApplicationsApplicationIdAttachmentsPositiveResponse
object
3 properties
3 required
PostAtsApplicationsApplicationIdResultLinksRequestBody
object
4 properties
2 required
GetAtsJobsParameterJobCodes
string
Filter by a comma-separated list of job codes.
PostAtsApplicationsApplicationIdInterviewsRequestBody
object
6 properties
6 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…
GetAtsRolesParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
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…
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…
GetAtsCandidatesParameterJobIds
string
Filter by a comma-separated list of job IDs. We will only return candidates that have applied to any of the jobs.
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.
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…
GetAtsApplicationStagesParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
GetAtsApplicationsParameterPageSize
integer
The number of results to return per page. Maximum is 250.
GetAtsJobsParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
GetAtsTagsParameterPageSize
integer
The number of results to return per page. Maximum is 250.
GetAtsCandidatesParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
GetAtsApplicationStagesParameterPageSize
integer
The number of results to return per page. Maximum is 250.
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…
GetAtsCandidatesCandidateIdAttachmentsPositiveResponse
object
3 properties
3 required
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…
GetAtsRejectionReasonsParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
GetAtsApplicationStagesParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
GetAtsJobsParameterNameContains
string
Filter by the name field. Can be used to find a job by keywords present in the job name.
GetAtsApplicationStagesParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
PostAtsApplicationsApplicationIdRejectRequestBody
object
3 properties
1 required
GetAtsCandidatesParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
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…
PostAtsApplicationsApplicationIdInterviewsPositiveResponse
object
2 properties
2 required
GetAtsOffersParameterPageSize
integer
The number of results to return per page. Maximum is 250.
PostAtsApplicationsApplicationIdNotesParameterApplicationId
string
The Kombo ID of the application you want to create the note for.
PatchAtsApplicationsApplicationIdInterviewsParameterApplicationId
string
The ID of the application
GetAtsRolesParameterPageSize
integer
The number of results to return per page. Maximum is 250.
GetAtsRolesParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
GetAtsInterviewsParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
GetAtsRejectionReasonsPositiveResponse
object
2 properties
2 required
GetAtsRejectionReasonsParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
GetAtsApplicationsParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
GetAtsInterviewsParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
PostAtsCandidatesCandidateIdResultLinksParameterCandidateId
string
The Kombo ID of the candidate you want to add the result link to.
GetAtsInterviewsParameterPageSize
integer
The number of results to return per page. Maximum is 250.
GetAtsRolesPositiveResponse
object
2 properties
2 required
PostAtsCandidatesCandidateIdTagsPositiveResponse
object
3 properties
3 required
PatchAtsApplicationsApplicationIdInterviewsPositiveResponse
object
2 properties
2 required
PostAtsApplicationsApplicationIdNotesRequestBody
object
3 properties
2 required
GetAtsTagsParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
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.
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…
PostAtsApplicationsApplicationIdInterviewsParameterApplicationId
string
The ID of the application
GetAtsInterviewsParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
GetAtsRejectionReasonsParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
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.
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…
GetAtsJobsParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
GetAtsRolesParameterCursor
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.
GetAtsOffersParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
GetAtsApplicationsApplicationIdAttachmentsParameterApplicationId
string
The Kombo ID of the application you want to obtain attachments for.
PutAtsApplicationsApplicationIdStagePositiveResponse
object
3 properties
3 required
GetAtsOffersParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
GetAtsApplicationStagesPositiveResponse
object
2 properties
2 required
GetAtsRolesParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
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.
PostAtsApplicationsApplicationIdResultLinksParameterApplicationId
string
The Kombo ID of the application you want to create the link for.
GetAtsJobsParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
GetAtsTagsParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
GetAtsUsersParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
GetAtsApplicationsParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
GetAtsUsersParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
GetAtsActionsAtsAddApplicationAttachmentPositiveResponse
object
2 properties
2 required
PostAtsApplicationsApplicationIdRejectParameterApplicationId
string
The Kombo ID of the application you want to reject.
GetAtsJobsParameterVisibilities
string
Filter by a comma-separated list of PUBLIC, INTERNAL, UNLISTED, CONFIDENTIAL Leave this blank to get results matching all values.
GetAtsUsersParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
GetAtsOffersParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
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…
PutAtsApplicationsApplicationIdStageRequestBody
object
2 properties
1 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…
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…
GetAtsCandidatesPositiveResponse
object
2 properties
2 required
DeleteAtsCandidatesCandidateIdTagsPositiveResponse
object
3 properties
3 required
GetAtsTagsParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
PostAtsCandidatesCandidateIdAttachmentsPositiveResponse
object
3 properties
3 required
PatchAtsApplicationsApplicationIdInterviewsRequestBody
object
7 properties
7 required
GetAtsRolesParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
GetAtsTagsPositiveResponse
object
2 properties
2 required
PostAtsJobsJobIdApplicationsRequestBody
object
8 properties
1 required
GetAtsCandidatesCandidateIdAttachmentsParameterCandidateId
string
The Kombo ID of the candidate you want to obtain attachments for.
GetAtsOffersParameterRemoteIds
string
Filter by a comma-separated list of remote IDs.
GetAtsJobsParameterPageSize
integer
The number of results to return per page. Maximum is 250.
GetAtsActionsAtsCreateApplicationPositiveResponse
object
2 properties
2 required
GetAtsCandidatesParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
DeleteAtsCandidatesCandidateIdTagsParameterCandidateId
string
The Kombo ID of the candidate you want to remove the tag from.
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…
PostAtsCandidatesPositiveResponse
object
3 properties
3 required
GetAtsUsersParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
PostAtsImportTrackedApplicationRequestBody
object
7 properties
1 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…
GetAtsJobsParameterStatus
string
(⚠️ Deprecated - Use the statuses filter instead.) Filter by the status field. Can be used to find a job based on its status.
PostAtsImportTrackedApplicationPositiveResponse
object
3 properties
3 required
GetAtsApplicationsParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
GetAtsRejectionReasonsParameterIncludeDeleted
string
By default, deleted entries are not returned. Use the includedeleted query param to include deleted entries too.
GetAtsCandidatesParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
PostAtsApplicationsApplicationIdNotesPositiveResponse
object
3 properties
3 required
GetAtsActionsAtsAddCandidateAttachmentPositiveResponse
object
2 properties
2 required
GetAtsCandidatesParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
GetAtsJobsParameterIds
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.
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.
PostAtsApplicationsApplicationIdAttachmentsRequestBody
object
2 properties
1 required
GetAtsJobsPositiveResponse
object
2 properties
2 required
PostAtsApplicationsApplicationIdAttachmentsParameterApplicationId
string
PostAtsCandidatesCandidateIdTagsRequestBody
object
2 properties
1 required
PostAtsJobsJobIdApplicationsPositiveResponse
object
3 properties
3 required
GetAtsRejectionReasonsParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
GetAtsUsersParameterPageSize
integer
The number of results to return per page. Maximum is 250.
GetAtsJobsParameterIgnoreUnsupportedFilters
string
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
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…
GetAtsJobsParameterEmploymentTypes
string
Filter by a comma-separated list of FULLTIME, PARTTIME, CONTRACT, SEASONAL, INTERNSHIP Leave this blank to get results matching all values.
PostAtsCandidatesCandidateIdResultLinksPositiveResponse
object
3 properties
3 required
GetAtsTagsParameterIds
string
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Kombo publishes across the network.