Deel Subpackage Ats API
The subpackage_ats API from Deel — 20 operation(s) for subpackage_ats.
Deel Subpackage Ats API is one of 128 APIs that Deel publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes 23 operations across 20 paths, and defines 281 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.letsdeel.com/rest/v2, https://api-staging.letsdeel.com/rest/v2.
23 operations
20 paths
281 schemas
17 GET6 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Deel Subpackage Ats API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (deelToken).
It accepts HTTP bearer tokens (oauth2).
deelToken— Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authenticatio…oauth2— Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/
Paths & Operations 23
Across 20 paths, the API surfaces 23 operations — 17 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.
subpackage_ats 23
POST
/ats/applications/{application_id}/notes
Add note to an application
POST
/ats/applications/{application_id}/interview-plan-stages
Associate application with an interview plan stage
POST
/ats/applications
Create ATS Application
GET
/ats/applications
Retrieve a list of ATS applications
POST
/ats/candidates
Create ATS Candidate
GET
/ats/candidates
Retrieve paginated list of ATS Candidates
POST
/ats/jobs
Create ATS Job
GET
/ats/jobs
Retrieve a list of ATS jobs
POST
/ats/candidates/{candidate_id}/tags
Create candidate tags
GET
/ats/tags
List tags
GET
/ats/application-sources
Retrieve a list of ATS application sources
GET
/ats/departments
Retrieve a list of ATS departments
GET
/ats/employment-types
Retrieve a list of ATS employment types
GET
/ats/job-boards/{job_board_id}/job-postings
Retrieve a list of ATS job postings
GET
/ats/locations
Retrieve a list of ATS locations
GET
/ats/offers
Retrieve a list of ATS offers
GET
/ats/email-templates
Retrieve a list of published ATS email templates
GET
/ats/applications/{application_id}
Retrieve ATS application
GET
/ats/hiring-members
Retrieve ATS hiring members
GET
/ats/job-postings/{job_posting_id}
Retrieve ATS job posting
GET
/ats/job-postings
Retrieve ATS job postings
GET
/ats/attachments/{attachable_type_slug}/{attachable_id}/{attachment_type_slug}
Retrieve paginated list of ATS attachment files
GET
/ats/reasons
Retrieve paginated list of ATS Rejection/Archivation reasons
Schemas 281
The contract defines 281 schemas that model the data the API accepts and returns. The most detailed are AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaData (22 properties), AtsJobsGetResponsesContentApplicationJsonSchemaDataItems (20 properties), AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItems (17 properties), AtsOffersGetResponsesContentApplicationJsonSchemaDataItems (16 properties). Each schema is shown below with its type and property counts.
RetrieveAtsApplication-v2026-01-01RequestInternalServerError
object
1 property
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems
object
Single job–employment-type link with nested employment type details.
2 properties
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentType
object
Employment type information for the job
2 properties
2 required
ATS_createAtsApplication-v2026-01-01_Response_201
object
1 property
1 required
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf2Type
string
The type of the question
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState
object
Current publication state details
5 properties
3 required
RetrieveAListOfAtsOffers-v2026-01-01RequestBadRequestError
object
2 properties
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsActionTypeEnum
string
Type of action performed by the automation rule
RetrieveAtsApplication-v2026-01-01RequestBadRequestError
object
1 property
CreateCandidateTags-v2026-02-27RequestInternalServerError
object
3 properties
3 required
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItemsCategoryTypeSlug
string
Category type of the interview plan stage
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsJobBoard
object
Job board where the posting is published
1 property
1 required
ATS_retrieveAtsJobPostings-v2026-04-10_Response_200
object
4 properties
4 required
ATS_retrieveAListOfAtsApplicationSources_Response_200
object
4 properties
4 required
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems
object
3 properties
3 required
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems
object
2 properties
2 required
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems
object
Single publication of the job posting to a job board.
3 properties
3 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItems
object
17 properties
17 required
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems
object
Single job-team link with nested team details.
2 properties
ATS_retrieveAListOfAtsJobPostings_Response_200
object
4 properties
ATS_addNoteToAnApplication-v2026-01-01_Response_201
object
1 property
1 required
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItemsDepartment
object
Department associated with the job
2 properties
AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachableTypeSlug
string
ATS_createAtsCandidate-v2026-01-01_Response_201
object
1 property
1 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoard
object
Job board details where the application originated
2 properties
2 required
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItems
object
2 properties
1 required
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItems
object
Parsed form submission answer
4 properties
4 required
AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaDataItems
object
11 properties
5 required
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf0Type
string
The type of the question
AddNoteToAnApplication-v2026-01-01RequestInternalServerError
object
1 property
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType
object
Details for the employment type assigned to the job
2 properties
2 required
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation
object
Compensation information for the job
4 properties
2 required
ATS_listTags-v2026-02-27_Response_200
object
4 properties
4 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJob
object
Job details
2 properties
2 required
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation
object
Location entity for this association.
2 properties
CreateCandidateTags-v2026-02-27RequestBadRequestError
object
4 properties
4 required
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam
object
Team referenced by this association.
2 properties
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf6Type
string
The type of the question
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems
object
Single job-location link with nested location details.
2 properties
AtsLocationsGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
AtsLocationsGetResponsesContentApplicationJsonSchemaDataItemsLocationGroup
object
Location group information
2 properties
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobPosting
object
Job posting information (if application came through a posting)
2 properties
2 required
ATS_retrievePaginatedListOfAtsAttachmentFiles-v2026-01-01_Response_200
object
4 properties
4 required
AtsApplicationsGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItemsTeam
object
Details for the team assigned to the job
2 properties
2 required
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation
object
Current compensation when visible on the posting; null when hidden or absent. Shape mirrors internal compensation mapping.
4 properties
ATS_retrieveAListOfAtsEmploymentTypes_Response_200
object
4 properties
4 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsInterviewPlanStage
object
Interview plan stage details
4 properties
4 required
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJob
object
Associated job information
6 properties
4 required
ATS_retrieveAListOfAtsOffers-v2026-01-01_Response_200
object
4 properties
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStageInterviewPlanStage
object
4 properties
4 required
ATS_retrievePaginatedListOfAtsCandidates-v2026-01-01_Response_200
object
4 properties
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf11Type
string
The type of the question
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard
object
Job board where the posting is published
1 property
1 required
AtsHiringMembersGetResponsesContentApplicationJsonSchemaDataItems
object
9 properties
AtsJobsGetResponsesContentApplicationJsonSchemaItems
object
3 properties
AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsEmailTemplate
object
Associated email template
2 properties
2 required
AtsHiringMembersGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
3 required
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug
string
Publication lifecycle state (uppercase slug).
ATS_retrieveAtsJobPosting_Response_200
object
1 property
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItemsDepartment
object
Details for the department associated with the job
2 properties
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment
object
Details for the department associated with the job
2 properties
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems5
object
4 properties
4 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoardType
string
Type of job board
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentState
object
Current publication state details
5 properties
3 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItems
object
Candidate tag
2 properties
2 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataDelayUnit
string
The unit of time for the delay. Must be provided together with delayamount. Cannot be used together with scheduledsendat.
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublication
object
Job posting publication details
1 property
1 required
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsAnswer
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaItems
object
2 properties
ListTags-v2026-02-27RequestInternalServerError
object
3 properties
3 required
AtsJobsPostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
AtsReasonsGetResponsesContentApplicationJsonSchemaDataItems
object
9 properties
4 required
RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestBadRequestError
object
1 property
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStage
object
Current interview plan stage information for the application
4 properties
4 required
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItems
object
2 properties
2 required
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsStatus
string
Job status
RetrieveAListOfAtsApplications-v2026-01-01RequestBadRequestError
object
1 property
AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaData
object
The created application interview plan stage record
3 properties
3 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmission
object
Application form submission data with mapped answers
2 properties
2 required
RetrieveAtsJobPostings-v2026-04-10RequestBadRequestError
object
4 properties
4 required
ATS_retrieveAtsHiringMembers_Response_200
object
4 properties
AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStage
object
6 properties
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType
object
Employment type entity for this association.
2 properties
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataSourceSlug
string
Source of the application
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentStateStateSlug
string
Current publication state
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems11
object
3 properties
3 required
AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsWorkerTypeEnum
string
Type of worker for the offer
AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItems
object
2 properties
2 required
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems
object
2 properties
2 required
AddNoteToAnApplication-v2026-01-01RequestBadRequestError
object
1 property
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems7
object
3 properties
3 required
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf4Type
string
The type of the question
RetrieveAListOfAtsEmploymentTypesRequestBadRequestError
object
1 property
AtsCandidatesPostRequestBodyContentApplicationJsonSchemaData
object
6 properties
3 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsEmail
object
Email message associated with the offer
7 properties
7 required
AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
3 required
CreateAtsCandidate-v2026-01-01RequestBadRequestError
object
1 property
AtsLocationsGetResponsesContentApplicationJsonSchemaDataItems
object
9 properties
4 required
AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItems
object
2 properties
2 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsOfferStatusEnum
string
Status of the offer
AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItemsEmploymentType
object
2 properties
2 required
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems1
object
3 properties
3 required
RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestInternalServerError
object
1 property
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob
object
Nested job record: locations, employment types, optional teams/departments, and optional compensation when visible.
6 properties
4 required
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems9
object
8 properties
8 required
CreateAtsJobRequestBadRequestError
object
1 property
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidate
object
Candidate information associated with the application
7 properties
7 required
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataNotesItems
object
1 property
1 required
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypeEmploymentType
object
2 properties
2 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStage
object
Current interview plan stage for the application
2 properties
2 required
AtsReasonsGetParametersReasonGroupSlug
string
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems4
object
3 properties
3 required
AtsApplicationsPostResponsesContentApplicationJsonSchemaData
object
10 properties
10 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItems
object
4 properties
4 required
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItems
object
2 properties
2 required
ATS_createAtsJob_Response_201
object
1 property
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems2
object
3 properties
3 required
AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus
string
Offer status
AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaData
object
9 properties
3 required
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItems
object
9 properties
8 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPosting
object
Job posting details
2 properties
2 required
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsSourceSlug
string
Source of the application
AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationStateStateSlug
string
State of the job posting publication
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItems
object
2 properties
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStageInterviewPlanStage
object
Details of the interview plan stage
4 properties
4 required
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItems
object
2 properties
2 required
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf10Type
string
The type of the question
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItemsLocation
object
Location associated with the job
2 properties
AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItemsLocation
object
2 properties
2 required
RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestInternalServerError
object
1 property
AtsJobsGetParametersStatusSchemaItems
string
AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItems
object
3 properties
1 required
AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItemsTeam
object
2 properties
2 required
AtsJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
3 required
AtsTagsGetParametersIncludeCounts
string
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItemsOperatorEnum
string
Comparison operator used in the evaluation
AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsEmail
object
Email details
7 properties
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems
object
2 properties
2 required
ATS_retrieveAListOfAtsDepartments_Response_200
object
4 properties
4 required
RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestBadRequestError
object
2 properties
AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItems
object
2 properties
2 required
AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItemsRoleSlug
string
The role of the participant in the activity
ATS_retrieveAListOfAtsJobs_Response_200
object
4 properties
AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItemsTag
object
2 properties
AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItems
object
2 properties
2 required
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItemsTeam
object
Team associated with the job
2 properties
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug
string
Current publication state
RetrieveAListOfAtsApplications-v2026-01-01RequestInternalServerError
object
1 property
AtsTagsGetResponsesContentApplicationJsonSchemaDataItems
object
8 properties
3 required
AtsReasonsGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
AtsCandidatesGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItemsEmploymentType
object
Employment type associated with the job
2 properties
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam
object
Details for the team assigned to the job
2 properties
2 required
AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItemsDepartment
object
2 properties
2 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentType
object
Employment type associated with the application
2 properties
2 required
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems8
object
4 properties
2 required
AtsReasonsGetParametersSubgroupSlug
string
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItems
object
2 properties
AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItemsTag
object
Tag details
2 properties
2 required
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems10
object
3 properties
3 required
AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsSubgroupSlug
string
Reason subgroup slug
AtsOffersGetResponsesContentApplicationJsonSchemaDataItems
object
16 properties
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaData
object
22 properties
21 required
RetrieveAListOfAtsLocations-v2026-01-01RequestBadRequestError
object
1 property
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItems
object
15 properties
4 required
AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItems
object
2 properties
2 required
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm
object
Linked application form metadata when the posting uses an application form.
2 properties
AtsJobsGetResponsesContentApplicationJsonSchemaDataItems
object
20 properties
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf8Type
string
The type of the question
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaItems
object
2 properties
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItemsTag
object
2 properties
2 required
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems
object
Single job-department link with nested department details.
2 properties
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItemsEmploymentType
object
Details for the employment type assigned to the job
2 properties
2 required
CreateAtsCandidate-v2026-01-01RequestInternalServerError
object
1 property
ATS_associateApplicationWithAnInterviewPlanStage-v2026-01-01_Response_201
object
1 property
1 required
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf1Type
string
The type of the question
AtsCandidatesPostResponsesContentApplicationJsonSchemaData
object
15 properties
7 required
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItems
object
6 properties
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMembersItems
object
2 properties
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateAttachmentsItems
object
2 properties
2 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsCompensationPeriodSlug
string
Compensation period
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItems
object
6 properties
6 required
RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestInternalServerError
object
1 property
AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsJob
object
2 properties
AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaDataItems
object
4 properties
4 required
RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestInternalServerError
object
1 property
ApiErrorContainer
object
2 properties
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItems
object
4 properties
4 required
AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageStatus
string
Status of the current application interview plan stage
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmission
object
Application form submission data with parsed answers
2 properties
2 required
AtsJobsPostResponsesContentApplicationJsonSchemaDataStatus
string
Current status of the job
AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItems
object
4 properties
AtsJobsPostRequestBodyContentApplicationJsonSchemaData
object
8 properties
4 required
ApiErrorRequest
object
7 properties
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems3
object
3 properties
3 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationState
object
Current state of the job posting publication
2 properties
2 required
ListTags-v2026-02-27RequestBadRequestError
object
4 properties
4 required
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems
object
2 properties
1 required
ATS_retrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01_Response_200
object
4 properties
4 required
AtsApplicationsPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMemberJobPermissionsByTypeSlug
object
Hiring member job permissions by type slug
6 properties
AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItems
object
14 properties
AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItems
object
4 properties
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItems
object
4 properties
4 required
AtsTagsGetResponsesContentApplicationJsonSchemaDataItemsTagGroupSlug
string
Tag group. Use CANDIDATE for candidate tags.
AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
ATS_retrieveAtsApplication-v2026-01-01_Response_200
object
1 property
1 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsJobCriteria
object
Job criteria details
3 properties
3 required
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems0
object
3 properties
3 required
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItems
object
2 properties
2 required
ATS_retrieveAListOfPublishedAtsEmailTemplates-v2026-02-11_Response_200
object
4 properties
4 required
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItems
object
10 properties
7 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentTypeEmploymentType
object
Employment type metadata
2 properties
2 required
AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaDataItems
object
4 properties
4 required
AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItems
object
2 properties
2 required
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm
object
Application form assigned to the job posting
2 properties
2 required
AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaDataItems
object
4 properties
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidate
object
Candidate details
9 properties
9 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsAnswer
The answer value
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf7Type
string
The type of the question
AtsDepartmentsGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaData
object
3 properties
3 required
ATS_retrieveAListOfAtsLocations-v2026-01-01_Response_200
object
4 properties
4 required
RetrieveAListOfAtsDepartmentsRequestBadRequestError
object
1 property
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensationPeriodSlug
string
Compensation period
AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsReasonGroupSlug
string
Reason group slug
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf3Type
string
The type of the question
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob
object
Associated job information
6 properties
4 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsQuestionType
string
Type of the question (uppercase)
AtsApplicationsApplicationIdNotesPostRequestBodyContentApplicationJsonSchemaData
object
2 properties
2 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsIsMatched
string
Whether the candidate matches this job criteria
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItems
object
4 properties
4 required
AtsApplicationsGetParametersSortOrder
string
AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItemsIsMatched
string
The matching state for the job criteria
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensation
object
Current compensation details
6 properties
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobCompensation
object
Compensation information for the job
4 properties
2 required
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard
object
Job board this publication belongs to.
1 property
1 required
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaData
object
9 properties
8 required
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataApplicationForm
object
Application form assigned to the job posting
2 properties
2 required
RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestBadRequestError
object
1 property
ApiError
object
2 properties
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaData
object
6 properties
3 required
ATS_retrieveAListOfAtsApplications-v2026-01-01_Response_200
object
4 properties
4 required
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItems
object
2 properties
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItems
object
4 properties
4 required
AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageInterviewPlanStage
object
7 properties
AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachmentTypeSlug
string
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems
RetrieveAtsHiringMembersRequestBadRequestError
object
1 property
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment
object
Department for this association; null if unset.
2 properties
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJob
object
Job information for the application
2 properties
2 required
RetrieveAtsJobPostings-v2026-04-10RequestInternalServerError
object
3 properties
3 required
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsQuestionType
string
Type of the question (uppercase)
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataReferralFormSubmission
object
Referral form submission metadata
2 properties
2 required
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItems
object
3 properties
3 required
CreateAtsApplication-v2026-01-01RequestBadRequestError
object
1 property
AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation
object
Details for the location assigned to the job
2 properties
2 required
AtsDepartmentsGetResponsesContentApplicationJsonSchemaDataItems
object
4 properties
4 required
AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItemsIsMatched
string
Whether the criteria is matched
AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItems
object
2 properties
AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItemsLocation
object
Details for the location assigned to the job
2 properties
2 required
AtsTagsGetParametersTagGroupSlug
string
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf5Type
string
The type of the question
AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsWorkerType
string
Worker type
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf9Type
string
The type of the question
AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaDataItems
object
4 properties
4 required
AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataNotesItems
object
Note associated with the application
5 properties
5 required
AtsApplicationsGetParametersSortBy
string
CreateAtsApplication-v2026-01-01RequestInternalServerError
object
1 property
AtsJobsPostResponsesContentApplicationJsonSchemaData
object
14 properties
10 required
AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems6
object
3 properties
3 required
ATS_createCandidateTags-v2026-02-27_Response_201
object
1 property
1 required
AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState
object
Latest known publication state for this board.
5 properties
5 required
RetrieveAtsHiringMembersRequestInternalServerError
object
1 property
AtsCandidatesPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Deel 12
Other APIs Deel publishes across the network.
Deel Adjustments API
Deel Applications API
Deel Candidates API
Deel Contractor Amendments API
Deel Contractor Hiring API
Deel Contracts API
Deel Custom Fields API
Deel IT API
Deel EOR Amendments API
Deel EOR Benefits API
Deel EOR Cost Calculator API
Deel EOR Hiring API
Where this information came from
This is an independent, third-party profile of Deel Subpackage Ats API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.