Skip to content

Deel: ATS applications schemas

70 Deel schemas with complete fields and constraints.

← ATS applications operations · All schemas

Add note to an application — ats Applications add Note To An Application V20261106 — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
richtext_contentstringRequired within parentThe content of the note in rich text HTML format

Add note to an application — ats Applications add Note To An Application — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add note to an application — ats Applications add Note To An Application — 201 response body — data
The created application note

Referenced models: Add note to an application — ats Applications add Note To An Application — 201 response body — data

Add note to an application — ats Applications add Note To An Application — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe created application note
created_atstringRequired within parentThe timestamp when the application note was created
Format: date-time
idstringRequired within parentThe unique identifier of the application note
Format: uuid
updated_atstringRequired within parentThe timestamp when the application note was last updated
Format: date-time

Add note to an application — ats Applications add Note To An Application — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
author_idstringRequired within parentThe UUID of the HRIS organization user creating the note
Format: uuid
richtext_contentstringRequired within parentThe content of the note in rich text HTML format

Assign application to interview plan stage — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Assign application to interview plan stage — 201 response body — data
The created application interview plan stage record

Referenced models: Assign application to interview plan stage — 201 response body — data

Assign application to interview plan stage — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe created application interview plan stage record
created_atstringRequired within parentThe timestamp when the record was created
Format: date-time
idstringRequired within parentThe unique identifier of the created application interview plan stage record
Format: uuid
updated_atstringRequired within parentThe timestamp when the record was last updated
Format: date-time

Assign application to interview plan stage — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
applicable_job_activitiesarrayOptionalOptional array of job activities to trigger when associating the application with this stage. If not provided, all activities will be triggered. If an empty array is provided, no activities will be triggered.
applicable_job_activities[]ModelEach itemExpand Assign application to interview plan stage — request body — body data applicable job activities item
candidate_archivation_email_template_idstringOptionalOptional ID of the rejection email template if the candidate is being archived
Format: uuid
candidate_archivation_reason_idstringOptionalOptional ID of the archivation reason if the candidate is being archived
Format: uuid
creator_idstringOptionalIgnored. The move is always recorded as made by the calling user, service accounts included.
Format: uuid
delay_amountintegerOptionalThe amount of time to delay the archivation email. Must be provided together with delay_unit. Cannot be used together with scheduled_send_at.
Maximum: 100
Minimum: 1
delay_unitstringOptionalThe unit of time for the delay. Must be provided together with delay_amount. Cannot be used together with scheduled_send_at.
One of: hours, days, weeks
expected_current_interview_plan_stage_idstringOptionalOptional precondition: the application's current interview plan stage ID as last read. If the application has moved since, nothing changes and a 409 precondition_failed is returned.
Format: uuid
interview_plan_stage_idstringRequired within parentThe ID of the interview plan stage to associate with the application
Format: uuid
is_current_stagebooleanRequired within parentWhen true, sets this stage as the application's current stage in the hiring workflow. When false, creates a historical record without changing the application's current stage.
scheduled_send_atstringOptionalThe exact future datetime to send the archivation email. Cannot be used together with delay_amount/delay_unit.
Format: date-time

Referenced models: Assign application to interview plan stage — request body — body data applicable job activities item

Assign application to interview plan stage — request body — body data applicable job activities item

FieldTypePresenceDescription and constraints
$objectRoot
candidate_self_scheduling_email_template_idstringOptionalOptional custom email template ID for candidate self-scheduling (only applicable for interview scheduling activities)
Format: uuid
idstringRequired within parentThe ID of the job activity to trigger
Format: uuid
participantsarrayOptionalOptional array of custom participants for this activity. If not provided, the default participants from the job activity template will be used.
participants[]ModelEach itemExpand Create a stage move for an application — request body — body data applicable job activities item participants item

Referenced models: Create a stage move for an application — request body — body data applicable job activities item participants item

Create ATS Application — 201 response body

FieldTypePresenceDescription and constraints
$objectRootCreated application response
dataModelRequired within parentExpand Create ATS Application — 201 response body — data

Referenced models: Create ATS Application — 201 response body — data

Create ATS Application — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
candidate_idstringRequired within parentCandidate unique identifier
Format: uuid
created_atstringRequired within parentCreation timestamp
Format: date-time
current_application_interview_plan_stage_idJSONRequired within parent
current_application_interview_plan_stage_id (anyOf 1)stringAlternativeCurrent interview plan stage identifier
Format: uuid
current_application_interview_plan_stage_id (anyOf 2)nullAlternativeCurrent interview plan stage identifier
Format: uuid
idstringRequired within parentApplication unique identifier
Format: uuid
job_employment_type_idJSONRequired within parent
job_employment_type_id (anyOf 1)stringAlternativeJob employment type identifier
Format: uuid
job_employment_type_id (anyOf 2)nullAlternativeJob employment type identifier
Format: uuid
job_idstringRequired within parentJob unique identifier
Format: uuid
job_posting_idJSONRequired within parent
job_posting_id (anyOf 1)stringAlternativeJob posting unique identifier
Format: uuid
job_posting_id (anyOf 2)nullAlternativeJob posting unique identifier
Format: uuid
moved_to_current_stage_atJSONRequired within parent
moved_to_current_stage_at (anyOf 1)stringAlternativeWhen application moved to current stage
Format: date-time
moved_to_current_stage_at (anyOf 2)nullAlternativeWhen application moved to current stage
Format: date-time
numeric_idJSONRequired within parent
numeric_id (anyOf 1)integerAlternativeApplication numeric identifier
numeric_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
source_slugJSONOptional
source_slug (anyOf 1)stringAlternativeThe application source slug in uppercase
source_slug (anyOf 2)nullAlternativeThe application source slug in uppercase
updated_atstringRequired within parentLast update timestamp
Format: date-time

Create ATS Application — request body — body / data / application_form_submission_data / item / type: ADDRESS

FieldTypePresenceDescription and constraints
$objectRoot
address_citystringRequired within parentCity
address_countrystringRequired within parentCountry
address_numberstringRequired within parentStreet number
address_statestringRequired within parentState
address_streetstringRequired within parentStreet name
address_zip_codestringRequired within parentZIP code
question_idstringRequired within parentQuestion identifier
typestringRequired within parentQuestion type this answer belongs to.
One of: ADDRESS

Create ATS Application — request body — body / data / application_form_submission_data / item / type: CUSTOMDROPDOWN

FieldTypePresenceDescription and constraints
$objectRoot
question_idstringRequired within parentQuestion identifier
selected_option_idsarrayRequired within parentSelected option IDs
selected_option_ids[]stringEach item
typestringRequired within parentQuestion type this answer belongs to.
One of: CUSTOMDROPDOWN

Create ATS Application — request body — body / data / application_form_submission_data / item / type: DATEPICKER

FieldTypePresenceDescription and constraints
$objectRoot
end_datestringOptionalEnd date (for ranges)
question_idstringRequired within parentQuestion identifier
start_datestringOptionalStart date
typestringRequired within parentQuestion type this answer belongs to.
One of: DATEPICKER

Create ATS Application — request body — body / data / application_form_submission_data / item / type: DOCUMENTUPLOAD

FieldTypePresenceDescription and constraints
$objectRoot
document_idsarrayRequired within parentDocument IDs
document_ids[]stringEach item
question_idstringRequired within parentQuestion identifier
typestringRequired within parentQuestion type this answer belongs to.
One of: DOCUMENTUPLOAD

Create ATS Application — request body — body / data / application_form_submission_data / item / type: EMAIL

FieldTypePresenceDescription and constraints
$objectRoot
emailstringRequired within parentEmail address
Format: email
question_idstringRequired within parentQuestion identifier
typestringRequired within parentQuestion type this answer belongs to.
One of: EMAIL

Create ATS Application — request body — body / data / application_form_submission_data / item / type: FREETEXT

FieldTypePresenceDescription and constraints
$objectRoot
answerstringRequired within parentText answer
question_idstringRequired within parentQuestion identifier
typestringRequired within parentQuestion type this answer belongs to.
One of: FREETEXT

Create ATS Application — request body — body / data / application_form_submission_data / item / type: MULTISELECTION

FieldTypePresenceDescription and constraints
$objectRoot
question_idstringRequired within parentQuestion identifier
selected_option_idsarrayRequired within parentSelected option IDs
selected_option_ids[]stringEach item
typestringRequired within parentQuestion type this answer belongs to.
One of: MULTISELECTION

Create ATS Application — request body — body / data / application_form_submission_data / item / type: NUMBER

FieldTypePresenceDescription and constraints
$objectRoot
question_idstringRequired within parentQuestion identifier
typestringRequired within parentQuestion type this answer belongs to.
One of: NUMBER
valuestringRequired within parentNumeric value

Create ATS Application — request body — body / data / application_form_submission_data / item / type: PARAGRAPH

FieldTypePresenceDescription and constraints
$objectRoot
answerstringRequired within parentParagraph answer
question_idstringRequired within parentQuestion identifier
typestringRequired within parentQuestion type this answer belongs to.
One of: PARAGRAPH

Create ATS Application — request body — body / data / application_form_submission_data / item / type: PHONENUMBER

FieldTypePresenceDescription and constraints
$objectRoot
phone_numberstringRequired within parentPhone number
question_idstringRequired within parentQuestion identifier
typestringRequired within parentQuestion type this answer belongs to.
One of: PHONENUMBER

Create ATS Application — request body — body / data / application_form_submission_data / item / type: PRESETDROPDOWN

FieldTypePresenceDescription and constraints
$objectRoot
presetstringRequired within parentPreset name
question_idstringRequired within parentQuestion identifier
selected_optionsarrayRequired within parentSelected options
selected_options[]stringEach item
typestringRequired within parentQuestion type this answer belongs to.
One of: PRESETDROPDOWN

Create ATS Application — request body — body / data / application_form_submission_data / item / type: SINGLESELECTION

FieldTypePresenceDescription and constraints
$objectRoot
question_idstringRequired within parentQuestion identifier
selected_option_idstringRequired within parentSelected option ID
typestringRequired within parentQuestion type this answer belongs to.
One of: SINGLESELECTION

Create ATS Application — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
application_form_submission_dataarray or nullOptionalArray of form submission answers
application_form_submission_data[]ModelEach itemExpand Create ATS Application — request body — body data application form submission data item
candidate_idstringRequired within parentThe ID of the candidate applying
Format: uuid
job_employment_type_idstringRequired within parentThe ID of the employment type for this job
Format: uuid
job_idstringRequired within parentThe ID of the job for this application
Format: uuid
job_posting_idstring or nullOptionalThe ID of the job posting (optional)
Format: uuid
notesarray or nullOptionalArray of notes to attach to the application
notes[]ModelEach itemExpand Create ATS Application — request body — body data notes item
source_slugstringOptionalThe application source. Accepts any active source slug of the organization, e.g. SOURCED_INTERNALLY, SOURCED_EXTERNALLY, INTERNAL_REFERRAL_AWARE, INTERNAL_REFERRAL_NOT_AWARE, EXTERNAL_CAREER_PAGE or a custom source slug (case-insensitive). Defaults to the candidate origin source when omitted.

Referenced models: Create ATS Application — request body — body data application form submission data item, Create ATS Application — request body — body data notes item

Create ATS Application — request body — body data application form submission data item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: FREETEXT
$ (oneOf 2)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: PARAGRAPH
$ (oneOf 3)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: SINGLESELECTION
$ (oneOf 4)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: MULTISELECTION
$ (oneOf 5)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: DOCUMENTUPLOAD
$ (oneOf 6)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: PRESETDROPDOWN
$ (oneOf 7)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: CUSTOMDROPDOWN
$ (oneOf 8)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: NUMBER
$ (oneOf 9)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: DATEPICKER
$ (oneOf 10)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: ADDRESS
$ (oneOf 11)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: PHONENUMBER
$ (oneOf 12)ModelAlternativeExpand Create ATS Application — request body — body / data / application_form_submission_data / item / type: EMAIL

Referenced models: Create ATS Application — request body — body / data / application_form_submission_data / item / type: FREETEXT, Create ATS Application — request body — body / data / application_form_submission_data / item / type: PARAGRAPH, Create ATS Application — request body — body / data / application_form_submission_data / item / type: PHONENUMBER, Create ATS Application — request body — body / data / application_form_submission_data / item / type: EMAIL, Create ATS Application — request body — body / data / application_form_submission_data / item / type: SINGLESELECTION, Create ATS Application — request body — body / data / application_form_submission_data / item / type: MULTISELECTION, Create ATS Application — request body — body / data / application_form_submission_data / item / type: DOCUMENTUPLOAD, Create ATS Application — request body — body / data / application_form_submission_data / item / type: PRESETDROPDOWN, Create ATS Application — request body — body / data / application_form_submission_data / item / type: CUSTOMDROPDOWN, Create ATS Application — request body — body / data / application_form_submission_data / item / type: NUMBER, Create ATS Application — request body — body / data / application_form_submission_data / item / type: DATEPICKER, Create ATS Application — request body — body / data / application_form_submission_data / item / type: ADDRESS

Create ATS Application — request body — body data notes item

FieldTypePresenceDescription and constraints
$objectRoot
richtext_contentstringRequired within parentThe richtext content of the note

Retrieve ATS application — 200 response body

FieldTypePresenceDescription and constraints
$objectRootSingle application response
dataModelRequired within parentExpand Retrieve ATS application — 200 response body — data
Complete application details

Referenced models: Retrieve ATS application — 200 response body — data

Retrieve ATS application — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootComplete application details
all_application_interview_plan_stagesarrayRequired within parentAll interview plan stages
all_application_interview_plan_stages[]ModelEach itemExpand Retrieve ATS application — 200 response body — data all application interview plan stages item
application_automation_rule_executionsarrayRequired within parentAutomation rule executions
application_automation_rule_executions[]ModelEach itemExpand Retrieve ATS application — 200 response body — data application automation rule executions item
application_form_submissionJSONOptionalApplication form submission data with mapped answers
application_form_submission (anyOf 1)ModelAlternativeExpand Retrieve ATS application — 200 response body — data application form submission answers, id
application_form_submission (anyOf 2)nullAlternative
application_job_criterias_matchingsarrayRequired within parentJob criteria matchings
application_job_criterias_matchings[]ModelEach itemExpand Retrieve ATS application — 200 response body — data application job criterias matchings item
archivation_reasonJSONRequired within parentArchivation reason details; null unless archived
archivation_reason (anyOf 1)ModelAlternativeExpand Retrieve ATS application — 200 response body — data archivation reason Archivation reason details; null unless archived
archivation_reason (anyOf 2)nullAlternative
archivation_reason_idJSONRequired within parent
archivation_reason_id (anyOf 1)stringAlternativeReason the application was archived; null unless archived
Format: uuid
archivation_reason_id (anyOf 2)nullAlternativeReason the application was archived; null unless archived
Format: uuid
candidateModelRequired within parentExpand Retrieve ATS application — 200 response body — data candidate
Candidate details
created_atstringRequired within parentTimestamp when the application was created
Format: date-time
created_byJSONRequired within parent
created_by (anyOf 1)stringAlternativeUnique identifier for the HRIS organization user who created the application
Format: uuid
created_by (anyOf 2)nullAlternativeUnique identifier for the HRIS organization user who created the application
Format: uuid
current_application_interview_plan_stageJSONRequired within parentCurrent interview plan stage for the application
current_application_interview_plan_stage (anyOf 1)ModelAlternativeExpand Retrieve ATS application — 200 response body — data current application interview plan stage Current interview plan stage for the application
current_application_interview_plan_stage (anyOf 2)nullAlternative
hired_atJSONRequired within parent
hired_at (anyOf 1)stringAlternativeTimestamp when the application reached the hired stage; null otherwise
Format: date-time
hired_at (anyOf 2)nullAlternativeTimestamp when the application reached the hired stage; null otherwise
Format: date-time
idstringRequired within parentUnique identifier for the application
Format: uuid
jobModelRequired within parentExpand Retrieve ATS application — 200 response body — data job
Job details
job_boardJSONRequired within parentJob board where application originated
job_board (anyOf 1)ModelAlternativeExpand Retrieve ATS application — 200 response body — data / job_board / type: INTERNAL CAREER PAGE, EXTERNAL CAREER PAGE, LINKEDIN
job_board (anyOf 2)nullAlternative
job_employment_typeJSONRequired within parentEmployment type associated with the application
job_employment_type (anyOf 1)ModelAlternativeExpand Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application
job_employment_type (anyOf 2)nullAlternative
job_postingJSONRequired within parentJob posting details
job_posting (anyOf 1)ModelAlternativeExpand Retrieve ATS application — 200 response body — data job posting Job posting details
job_posting (anyOf 2)nullAlternative
job_posting_publicationJSONRequired within parentJob posting publication details
job_posting_publication (anyOf 1)ModelAlternativeExpand Retrieve ATS application — 200 response body — data job posting publication Job posting publication details
job_posting_publication (anyOf 2)nullAlternative
job_posting_publication_stateJSONRequired within parentCurrent state of job posting publication
job_posting_publication_state (anyOf 1)ModelAlternativeExpand Retrieve ATS application — 200 response body — data job posting publication state Current state of job posting publication
job_posting_publication_state (anyOf 2)nullAlternative
moved_to_current_stage_atstringRequired within parentTimestamp when the application moved to the current stage
Format: date-time
notesarrayRequired within parentNotes on application
notes[]ModelEach itemExpand Retrieve ATS application — 200 response body — data notes item
numeric_idJSONRequired within parent
numeric_id (anyOf 1)integerAlternativeNumeric identifier for the application
numeric_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
referral_form_submissionModelRequired within parentExpand Retrieve ATS application — 200 response body — data referral form submission
Referral form submission metadata
referred_byJSONRequired within parent
referred_by (anyOf 1)stringAlternativeUnique identifier for the HRIS organization user who referred the candidate
Format: uuid
referred_by (anyOf 2)nullAlternativeUnique identifier for the HRIS organization user who referred the candidate
Format: uuid
source_channel_campaign_slugJSONRequired within parent
source_channel_campaign_slug (anyOf 1)stringAlternativeHiring campaign of the source channel the application came through; null when none
source_channel_campaign_slug (anyOf 2)nullAlternativeHiring campaign of the source channel the application came through; null when none
source_channel_medium_slugJSONRequired within parent
source_channel_medium_slug (anyOf 1)stringAlternativeKind of placement of the source channel the application came through; null when none
source_channel_medium_slug (anyOf 2)nullAlternativeKind of placement of the source channel the application came through; null when none
source_channel_nameJSONRequired within parent
source_channel_name (anyOf 1)stringAlternativeWhere the candidate clicked: the source channel of the source channel the application came through; null when none
source_channel_name (anyOf 2)nullAlternativeWhere the candidate clicked: the source channel of the source channel the application came through; null when none
source_slugJSONRequired within parent
source_slug (anyOf 1)stringAlternativeSource slug
source_slug (anyOf 2)nullAlternativeSource slug
submitter_ip_addressJSONOptional
submitter_ip_address (anyOf 1)stringAlternativeIP address of the applicant who submitted the application
submitter_ip_address (anyOf 2)nullAlternativeIP address of the applicant who submitted the application
submitter_user_agentJSONOptional
submitter_user_agent (anyOf 1)stringAlternativeUser agent of the applicant who submitted the application
submitter_user_agent (anyOf 2)nullAlternativeUser agent of the applicant who submitted the application
updated_atstringRequired within parentTimestamp when the application was last updated
Format: date-time

Referenced models: Retrieve ATS application — 200 response body — data archivation reason Archivation reason details; null unless archived, Retrieve ATS application — 200 response body — data job, Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application, Retrieve ATS application — 200 response body — data job posting Job posting details, Retrieve ATS application — 200 response body — data job posting publication Job posting publication details, Retrieve ATS application — 200 response body — data notes item, Retrieve ATS application — 200 response body — data all application interview plan stages item, Retrieve ATS application — 200 response body — data application automation rule executions item, Retrieve ATS application — 200 response body — data application form submission answers, id, Retrieve ATS application — 200 response body — data application job criterias matchings item, Retrieve ATS application — 200 response body — data candidate, Retrieve ATS application — 200 response body — data current application interview plan stage Current interview plan stage for the application, Retrieve ATS application — 200 response body — data / job_board / type: INTERNAL CAREER PAGE, EXTERNAL CAREER PAGE, LINKEDIN, Retrieve ATS application — 200 response body — data job posting publication state Current state of job posting publication, Retrieve ATS application — 200 response body — data referral form submission

Retrieve ATS application — 200 response body — data / job_board / type: INTERNAL CAREER PAGE, EXTERNAL CAREER PAGE, LINKEDIN

FieldTypePresenceDescription and constraints
$objectRootJob board where application originated
idstringRequired within parentJob board unique identifier
Format: uuid
typestringRequired within parentType of job board
Known values: INTERNAL_CAREER_PAGE, EXTERNAL_CAREER_PAGE, LINKEDIN

Retrieve ATS application — 200 response body — data all application interview plan stages item

FieldTypePresenceDescription and constraints
$objectRoot
entered_atstringRequired within parentTimestamp when the application entered this stage
Format: date-time
exited_atJSONRequired within parent
exited_at (anyOf 1)stringAlternativeTimestamp when the application left this stage; null while the application is still in it
Format: date-time
exited_at (anyOf 2)nullAlternativeTimestamp when the application left this stage; null while the application is still in it
Format: date-time
idstringRequired within parentUnique identifier for the application interview plan stage
Format: uuid
interview_plan_stageJSONRequired within parent
interview_plan_stage (anyOf 1)ModelAlternativeExpand Retrieve ATS application — 200 response body — data all application interview plan stages item interview plan stage category type slug, default type slug, id, name, position number
interview_plan_stage (anyOf 2)nullAlternative
is_currentbooleanRequired within parentWhether this is the stage the application is currently in
moved_by_hris_organization_user_idJSONRequired within parent
moved_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user who moved the application into this stage; null for automated moves
Format: uuid
moved_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user who moved the application into this stage; null for automated moves
Format: uuid
offersarrayRequired within parentArray of offers associated with this stage
offers[]ModelEach itemExpand Retrieve ATS application — 200 response body — data all application interview plan stages item offers item
updated_atJSONRequired within parent
updated_at (anyOf 1)stringAlternativeTimestamp when the stage was last updated
Format: date-time
updated_at (anyOf 2)nullAlternativeTimestamp when the stage was last updated
Format: date-time

Referenced models: Retrieve ATS application — 200 response body — data all application interview plan stages item interview plan stage category type slug, default type slug, id, name, position number, Retrieve ATS application — 200 response body — data all application interview plan stages item offers item

Retrieve ATS application — 200 response body — data all application interview plan stages item interview plan stage category type slug, default type slug, id, name, position number

FieldTypePresenceDescription and constraints
$objectRoot
category_type_slugstringRequired within parentCategory type slug
default_type_slugJSONRequired within parent
default_type_slug (anyOf 1)stringAlternativeDefault type slug
default_type_slug (anyOf 2)nullAlternativeDefault type slug
idstringRequired within parentInterview plan stage unique identifier
Format: uuid
namestringRequired within parentInterview plan stage name
position_numberJSONRequired within parent
position_number (anyOf 1)integerAlternativePosition of the stage in the interview plan
position_number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve ATS application — 200 response body — data all application interview plan stages item offers item

FieldTypePresenceDescription and constraints
$objectRootOffer details
application_interview_plan_stage_idstringRequired within parentUnique identifier for the application interview plan stage
Format: uuid
approval_request_idJSONRequired within parent
approval_request_id (anyOf 1)stringAlternativeUnique identifier for the approval request
Format: uuid
approval_request_id (anyOf 2)nullAlternativeUnique identifier for the approval request
Format: uuid
approval_rule_idJSONRequired within parent
approval_rule_id (anyOf 1)stringAlternativeUnique identifier for the approval rule
Format: uuid
approval_rule_id (anyOf 2)nullAlternativeUnique identifier for the approval rule
Format: uuid
attachment_idJSONRequired within parent
attachment_id (anyOf 1)stringAlternativeUnique identifier for the offer attachment
Format: uuid
attachment_id (anyOf 2)nullAlternativeUnique identifier for the offer attachment
Format: uuid
compensation_amountJSONRequired within parent
compensation_amount (anyOf 1)numberAlternativeCompensation amount
Format: double
compensation_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
compensation_currencystringRequired within parentCurrency code for compensation (ISO 4217)
compensation_period_slugJSONRequired within parentCompensation period
compensation_period_slug (anyOf 1)stringAlternativeCompensation period
Known values: ANNUALLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY
compensation_period_slug (anyOf 2)nullAlternative
country_codestringRequired within parentCountry code (ISO 3166-1 alpha-2)
created_atstringRequired within parentTimestamp when the offer was created
Format: date-time
emailJSONOptionalEmail message associated with the offer
email (anyOf 1)ModelAlternativeExpand Retrieve ATS application — 200 response body — data all application interview plan stages item offers item email Email message associated with the offer
email (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the offer
Format: uuid
job_titlestringRequired within parentJob title for the offer
offer_status_enumstringRequired within parentStatus of the offer
Known values: CREATED, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, SENT, EXPIRED, ACCEPTED, REJECTED
rejection_reason_idJSONRequired within parent
rejection_reason_id (anyOf 1)stringAlternativeUnique identifier for the rejection reason (if rejected)
Format: uuid
rejection_reason_id (anyOf 2)nullAlternativeUnique identifier for the rejection reason (if rejected)
Format: uuid
start_datestringRequired within parentStart date for the position
Format: date-time
updated_atstringRequired within parentTimestamp when the offer was last updated
Format: date-time
worker_type_enumstringRequired within parentType of worker for the offer
Known values: CONTRACTOR, DIRECT_EMPLOYEE, EOR_EMPLOYEE, GLOBAL_PAYROLL_EMPLOYEE, PEO_EMPLOYEE, UNKNOWN

Referenced models: Retrieve ATS application — 200 response body — data all application interview plan stages item offers item email Email message associated with the offer

Retrieve ATS application — 200 response body — data all application interview plan stages item offers item email Email message associated with the offer

FieldTypePresenceDescription and constraints
$objectRootEmail message associated with the offer
body_htmlstringRequired within parentHTML body of the email
from_stringstringRequired within parentEmail sender address
idstringRequired within parentUnique identifier for the email message
Format: uuid
recipients_bccarrayRequired within parentArray of BCC recipient email addresses
recipients_bcc[]stringEach item
recipients_ccarrayRequired within parentArray of CC recipient email addresses
recipients_cc[]stringEach item
recipients_toarrayRequired within parentArray of recipient email addresses
recipients_to[]stringEach item
subjectstringRequired within parentEmail subject line

Retrieve ATS application — 200 response body — data application automation rule executions item

FieldTypePresenceDescription and constraints
$objectRootApplication automation rule execution
action_type_enumstringRequired within parentType of action to execute
Known values: ADD_CANDIDATE_TAG, TRANSITION_APPLICATION
application_automation_rule_idstringRequired within parentAutomation rule identifier
Format: uuid
evaluation_resultarrayRequired within parentArray of evaluation results
evaluation_result[]ModelEach itemExpand Retrieve ATS application — 200 response body — data application automation rule executions item evaluation result item
idstringRequired within parentUnique identifier for the automation rule execution
Format: uuid

Referenced models: Retrieve ATS application — 200 response body — data application automation rule executions item evaluation result item

Retrieve ATS application — 200 response body — data application automation rule executions item evaluation result item

FieldTypePresenceDescription and constraints
$objectRootEvaluation result for automation rule
comparison_valuestringRequired within parentValue to compare against
form_builder_question_data_binding_idstringRequired within parentForm builder question data binding identifier
group_idJSONRequired within parent
group_id (anyOf 1)integerAlternativeGroup identifier for the condition
group_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentUnique identifier for the evaluation result
Format: uuid
is_condition_metbooleanRequired within parentWhether the condition is met
operator_enumstringRequired within parentComparison operator
Known values: EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, IS_EMPTY, IS_NOT_EMPTY, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL

Retrieve ATS application — 200 response body — data application form submission answers, id

FieldTypePresenceDescription and constraints
$objectRootApplication form submission data with mapped answers
answersarrayRequired within parentArray of question answers with parsed data
answers[]ModelEach itemExpand Retrieve ATS application — 200 response body — data application form submission answers, id answers item
idstringRequired within parentIdentifier of the application form submission
Format: uuid

Referenced models: Retrieve ATS application — 200 response body — data application form submission answers, id answers item

Retrieve ATS application — 200 response body — data application form submission answers, id answers item

FieldTypePresenceDescription and constraints
$objectRootForm submission answer
answerModelRequired within parentExpand Retrieve ATS application — 200 response body — data application form submission answers, id answers item answer
The answer value
data_binding_idstringRequired within parentData binding identifier for the question
question_textstringRequired within parentText of the question
question_typestringRequired within parentType of the question (uppercase)
Known values: FREETEXT, PARAGRAPH, SINGLESELECTION, MULTISELECTION, DOCUMENTUPLOAD, PRESETDROPDOWN, CUSTOMDROPDOWN, NUMBER, DATEPICKER, ADDRESS, PHONENUMBER, EMAIL

Referenced models: Retrieve ATS application — 200 response body — data application form submission answers, id answers item answer

Retrieve ATS application — 200 response body — data application form submission answers, id answers item answer

FieldTypePresenceDescription and constraints
$JSONRootThe answer value
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve ATS application — 200 response body — data application job criterias matchings item

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentMatch description
idstringRequired within parentJob criteria matching identifier
Format: uuid
is_matchedstringRequired within parentMatch status
Known values: MATCHED, NOT_MATCHED, UNDECIDED
job_criteriaModelRequired within parentExpand Retrieve ATS application — 200 response body — data application job criterias matchings item job criteria

Referenced models: Retrieve ATS application — 200 response body — data application job criterias matchings item job criteria

Retrieve ATS application — 200 response body — data application job criterias matchings item job criteria

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentJob criteria description
idstringRequired within parentJob criteria identifier
Format: uuid
titlestringRequired within parentJob criteria title

Retrieve ATS application — 200 response body — data archivation reason Archivation reason details; null unless archived

FieldTypePresenceDescription and constraints
$objectRootArchivation reason details; null unless archived
idstringRequired within parentArchivation reason identifier
Format: uuid
labelstringRequired within parentArchivation reason label

Retrieve ATS application — 200 response body — data candidate

FieldTypePresenceDescription and constraints
$objectRootCandidate details
attachmentsarrayRequired within parentArray of attachments associated with the candidate (e.g., resume, cover letter)
attachments[]ModelEach itemExpand Retrieve ATS application — 200 response body — data candidate attachments item
candidate_tagsarrayRequired within parentTags associated with the candidate
candidate_tags[]ModelEach itemExpand Retrieve ATS application — 200 response body — data candidate candidate tags item
cityJSONOptional
city (anyOf 1)stringAlternativeCandidate city
city (anyOf 2)nullAlternativeCandidate city
country_codeJSONOptional
country_code (anyOf 1)stringAlternativeCandidate country code (ISO 3166-1 alpha-2)
country_code (anyOf 2)nullAlternativeCandidate country code (ISO 3166-1 alpha-2)
emailstringRequired within parentCandidate email address
Format: email
first_namestringRequired within parentCandidate first name
idstringRequired within parentCandidate unique identifier
Format: uuid
import_session_idJSONRequired within parent
import_session_id (anyOf 1)stringAlternativeImport session identifier if bulk imported
import_session_id (anyOf 2)nullAlternativeImport session identifier if bulk imported
last_namestringRequired within parentCandidate last name
phone_numberJSONRequired within parent
phone_number (anyOf 1)stringAlternativeCandidate phone number
phone_number (anyOf 2)nullAlternativeCandidate phone number
profile_picture_urlJSONRequired within parent
profile_picture_url (anyOf 1)stringAlternativeCandidate profile picture URL
profile_picture_url (anyOf 2)nullAlternativeCandidate profile picture URL

Referenced models: Retrieve ATS application — 200 response body — data candidate candidate tags item, Retrieve ATS application — 200 response body — data candidate attachments item

Retrieve ATS application — 200 response body — data candidate attachments item

FieldTypePresenceDescription and constraints
$objectRoot
ai_summaryJSONRequired within parent
ai_summary (anyOf 1)stringAlternativeAI-generated summary of the attachment content
ai_summary (anyOf 2)nullAlternativeAI-generated summary of the attachment content
idstringRequired within parentUnique identifier for the attachment
Format: uuid

Retrieve ATS application — 200 response body — data candidate candidate tags item

FieldTypePresenceDescription and constraints
$objectRootCandidate tag
idstringRequired within parentUnique identifier for the candidate tag
Format: uuid
tagModelRequired within parentExpand Retrieve ATS application — 200 response body — data candidate candidate tags item tag
Tag details

Referenced models: Retrieve ATS application — 200 response body — data candidate candidate tags item tag

Retrieve ATS application — 200 response body — data candidate candidate tags item tag

FieldTypePresenceDescription and constraints
$objectRootTag details
idstringRequired within parentUnique identifier for the tag
Format: uuid
labelstringRequired within parentLabel of the tag

Retrieve ATS application — 200 response body — data current application interview plan stage Current interview plan stage for the application

FieldTypePresenceDescription and constraints
$objectRootCurrent interview plan stage for the application
idstringRequired within parentIdentifier of the application interview plan stage record
Format: uuid
interview_plan_stageJSONRequired within parent
interview_plan_stage (anyOf 1)ModelAlternativeExpand Retrieve ATS application — 200 response body — data all application interview plan stages item interview plan stage category type slug, default type slug, id, name, position number
interview_plan_stage (anyOf 2)nullAlternative

Referenced models: Retrieve ATS application — 200 response body — data all application interview plan stages item interview plan stage category type slug, default type slug, id, name, position number

Retrieve ATS application — 200 response body — data job

FieldTypePresenceDescription and constraints
$objectRootJob details
idstringRequired within parentUnique identifier for the job
Format: uuid
titlestringRequired within parentTitle of the job

Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application

FieldTypePresenceDescription and constraints
$objectRootEmployment type associated with the application
employment_typeModelRequired within parentExpand Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application employment type
Employment type metadata
idstringRequired within parentIdentifier of the job employment type record
Format: uuid

Referenced models: Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application employment type

Retrieve ATS application — 200 response body — data job employment type Employment type associated with the application employment type

FieldTypePresenceDescription and constraints
$objectRootEmployment type metadata
idstringRequired within parentIdentifier of the employment type
Format: uuid
namestringRequired within parentHuman readable employment type

Retrieve ATS application — 200 response body — data job posting Job posting details

FieldTypePresenceDescription and constraints
$objectRootJob posting details
idstringRequired within parentUnique identifier for the job posting
Format: uuid
titlestringRequired within parentTitle of the job posting

Retrieve ATS application — 200 response body — data job posting publication Job posting publication details

FieldTypePresenceDescription and constraints
$objectRootJob posting publication details
idstringRequired within parentJob posting publication unique identifier
Format: uuid

Retrieve ATS application — 200 response body — data job posting publication state Current state of job posting publication

FieldTypePresenceDescription and constraints
$objectRootCurrent state of job posting publication
idstringRequired within parentJob posting publication state identifier
Format: uuid
state_slugstringRequired within parentState of job posting publication
Known values: PUBLISHED_BASIC, PUBLISHED_PREMIUM, UNPUBLISHED, EXPIRED, IN_PROGRESS, FAILED

Retrieve ATS application — 200 response body — data notes item

FieldTypePresenceDescription and constraints
$objectRootNote associated with the application
created_atstringRequired within parentTimestamp when the note was created
Format: date-time
created_bystringRequired within parentUnique identifier for the user who created the note
Format: uuid
idstringRequired within parentUnique identifier for the note
Format: uuid
richtext_contentstringRequired within parentRich text content of the note
updated_atstringRequired within parentTimestamp when the note was last updated
Format: date-time

Retrieve ATS application — 200 response body — data referral form submission

FieldTypePresenceDescription and constraints
$objectRootReferral form submission metadata
form_builder_stringifiedJSONRequired within parent
form_builder_stringified (anyOf 1)stringAlternativeStringified JSON data for the referral form submission
form_builder_stringified (anyOf 2)nullAlternativeStringified JSON data for the referral form submission
idJSONRequired within parent
id (anyOf 1)stringAlternativeIdentifier of the referral form submission
Format: uuid
id (anyOf 2)nullAlternativeIdentifier of the referral form submission
Format: uuid

Retrieve a list of ATS applications — 200 response body

FieldTypePresenceDescription and constraints
$objectRootPaginated list of applications
dataarrayRequired within parentPage of applications
data[]ModelEach itemExpand Retrieve a list of ATS applications — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to fetch the next page; null when there are no more pages
next_cursor (anyOf 2)nullAlternativeCursor to fetch the next page; null when there are no more pages
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of applications
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a list of ATS applications — 200 response body — data item

Retrieve a list of ATS applications — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRootApplication object
application_form_form_builder_form_submission_idJSONOptional
application_form_form_builder_form_submission_id (anyOf 1)stringAlternativeApplication form submission unique identifier
Format: uuid
application_form_form_builder_form_submission_id (anyOf 2)nullAlternativeApplication form submission unique identifier
Format: uuid
application_form_submissionJSONOptionalApplication form submission data with parsed answers
application_form_submission (anyOf 1)ModelAlternativeExpand Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id
application_form_submission (anyOf 2)nullAlternative
application_job_criterias_matchingsarrayOptionalAI-generated job criteria matching results for the application
application_job_criterias_matchings[]ModelEach itemExpand Retrieve a list of ATS applications — 200 response body — data item application job criterias matchings item
archivation_reason_idJSONOptional
archivation_reason_id (anyOf 1)stringAlternativeReason the application was archived; null unless archived
Format: uuid
archivation_reason_id (anyOf 2)nullAlternativeReason the application was archived; null unless archived
Format: uuid
candidateModelOptionalExpand Retrieve a list of ATS applications — 200 response body — data item candidate
Candidate information associated with the application
created_atstringRequired within parentTimestamp of when the application was created
Format: date-time
created_by_hris_organization_user_idJSONOptional
created_by_hris_organization_user_id (anyOf 1)stringAlternativeUser who created the application
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeUser who created the application
Format: uuid
current_application_interview_plan_stageModelOptionalExpand Retrieve a list of ATS applications — 200 response body — data item current application interview plan stage
Current interview plan stage information for the application
current_application_interview_plan_stage_idJSONOptional
current_application_interview_plan_stage_id (anyOf 1)stringAlternativeCurrent interview plan stage unique identifier
Format: uuid
current_application_interview_plan_stage_id (anyOf 2)nullAlternativeCurrent interview plan stage unique identifier
Format: uuid
hired_atJSONOptional
hired_at (anyOf 1)stringAlternativeTimestamp when the application reached the hired stage; null otherwise
Format: date-time
hired_at (anyOf 2)nullAlternativeTimestamp when the application reached the hired stage; null otherwise
Format: date-time
idstringRequired within parentApplication unique identifier
Format: uuid
jobModelOptionalExpand Retrieve a list of ATS applications — 200 response body — data item job
Job information for the application
job_employment_typeModelOptionalExpand Retrieve a list of ATS applications — 200 response body — data item job employment type
Employment type information for the job
job_postingJSONOptionalJob posting information (if application came through a posting)
job_posting (anyOf 1)ModelAlternativeExpand Retrieve a list of ATS applications — 200 response body — data item job posting id, title
job_posting (anyOf 2)nullAlternative
moved_to_current_stage_atstringRequired within parentTimestamp of when the application moved to current stage
Format: date-time
numeric_idJSONRequired within parent
numeric_id (anyOf 1)integerAlternativeApplication numeric identifier
numeric_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
source_channel_campaign_slugJSONOptional
source_channel_campaign_slug (anyOf 1)stringAlternativeHiring campaign of the source channel the application came through; null when none
source_channel_campaign_slug (anyOf 2)nullAlternativeHiring campaign of the source channel the application came through; null when none
source_channel_medium_slugJSONOptional
source_channel_medium_slug (anyOf 1)stringAlternativeKind of placement of the source channel the application came through; null when none
source_channel_medium_slug (anyOf 2)nullAlternativeKind of placement of the source channel the application came through; null when none
source_channel_nameJSONOptional
source_channel_name (anyOf 1)stringAlternativeWhere the candidate clicked: the source channel of the source channel the application came through; null when none
source_channel_name (anyOf 2)nullAlternativeWhere the candidate clicked: the source channel of the source channel the application came through; null when none
source_slugJSONOptional
source_slug (anyOf 1)stringAlternativeSource of the application
source_slug (anyOf 2)nullAlternativeSource of the application
stage_historyarrayOptionalChronological stage timeline of the application. Present only when include=STAGE_HISTORY is requested.
stage_history[]ModelEach itemExpand Retrieve a list of ATS applications — 200 response body — data item stage history item
submitter_ip_addressJSONOptional
submitter_ip_address (anyOf 1)stringAlternativeIP address of the applicant who submitted the application
submitter_ip_address (anyOf 2)nullAlternativeIP address of the applicant who submitted the application
submitter_user_agentJSONOptional
submitter_user_agent (anyOf 1)stringAlternativeUser agent of the applicant who submitted the application
submitter_user_agent (anyOf 2)nullAlternativeUser agent of the applicant who submitted the application
updated_atstringOptionalTimestamp of when the application was last updated
Format: date-time

Referenced models: Retrieve a list of ATS applications — 200 response body — data item job, Retrieve a list of ATS applications — 200 response body — data item job employment type, Retrieve a list of ATS applications — 200 response body — data item job posting id, title, Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id, Retrieve a list of ATS applications — 200 response body — data item application job criterias matchings item, Retrieve a list of ATS applications — 200 response body — data item candidate, Retrieve a list of ATS applications — 200 response body — data item current application interview plan stage, Retrieve a list of ATS applications — 200 response body — data item stage history item

Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id

FieldTypePresenceDescription and constraints
$objectRootApplication form submission data with parsed answers
answersJSONRequired within parent
answers (anyOf 1)arrayAlternativeArray of parsed form submission answers
answers (anyOf 1)[]ModelEach itemExpand Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id answers Array of parsed form submission answers item
answers (anyOf 2)nullAlternativeArray of parsed form submission answers
answers (anyOf 2)[]ModelEach itemExpand Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id answers Array of parsed form submission answers item
idJSONRequired within parent
id (anyOf 1)stringAlternativeIdentifier of the application form submission
Format: uuid
id (anyOf 2)nullAlternativeIdentifier of the application form submission
Format: uuid

Referenced models: Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id answers Array of parsed form submission answers item

Retrieve a list of ATS applications — 200 response body — data item application form submission answers, id answers Array of parsed form submission answers item

FieldTypePresenceDescription and constraints
$objectRootParsed form submission answer
answerModelRequired within parentExpand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value
data_binding_idstringRequired within parentData binding identifier for the question
Format: uuid
question_textstringRequired within parentText of the question
question_typestringRequired within parentType of the question (uppercase)
Known values: FREETEXT, PARAGRAPH, SINGLESELECTION, MULTISELECTION, DOCUMENTUPLOAD, PRESETDROPDOWN, CUSTOMDROPDOWN, NUMBER, DATEPICKER, ADDRESS, PHONENUMBER, EMAIL

Referenced models: Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value

Retrieve a list of ATS applications — 200 response body — data item application job criterias matchings item

FieldTypePresenceDescription and constraints
$objectRootAI-generated job criteria matching result
descriptionstringRequired within parentJob criteria matching description
idstringRequired within parentJob criteria matching unique identifier
Format: uuid
is_matchedstringRequired within parentWhether the criteria is matched
Known values: MATCHED, NOT_MATCHED, UNDECIDED
job_criteria_idstringRequired within parentJob criteria unique identifier
Format: uuid

Retrieve a list of ATS applications — 200 response body — data item candidate

FieldTypePresenceDescription and constraints
$objectRootCandidate information associated with the application
candidate_tagsarrayRequired within parentTags associated with the candidate
candidate_tags[]ModelEach itemExpand Retrieve a list of ATS applications — 200 response body — data item candidate candidate tags item
cityJSONOptional
city (anyOf 1)stringAlternativeCandidate city
city (anyOf 2)nullAlternativeCandidate city
country_codeJSONOptional
country_code (anyOf 1)stringAlternativeCandidate country code (ISO 3166-1 alpha-2)
country_code (anyOf 2)nullAlternativeCandidate country code (ISO 3166-1 alpha-2)
emailstringRequired within parentCandidate email address
Format: email
first_namestringRequired within parentCandidate first name
idstringRequired within parentCandidate unique identifier
Format: uuid
last_namestringRequired within parentCandidate last name
phone_numberJSONRequired within parent
phone_number (anyOf 1)stringAlternativeCandidate phone number (may be empty string or null)
phone_number (anyOf 2)nullAlternativeCandidate phone number (may be empty string or null)
pic_urlJSONRequired within parent
pic_url (anyOf 1)stringAlternativeCandidate profile picture URL
pic_url (anyOf 2)nullAlternativeCandidate profile picture URL

Referenced models: Retrieve a list of ATS applications — 200 response body — data item candidate candidate tags item

Retrieve a list of ATS applications — 200 response body — data item candidate candidate tags item

FieldTypePresenceDescription and constraints
$objectRootCandidate tag with label
idstringRequired within parentCandidate tag unique identifier
Format: uuid
tagModelRequired within parentExpand Retrieve a list of ATS applications — 200 response body — data item candidate candidate tags item tag

Referenced models: Retrieve a list of ATS applications — 200 response body — data item candidate candidate tags item tag

Retrieve a list of ATS applications — 200 response body — data item candidate candidate tags item tag

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentTag unique identifier
Format: uuid
labelstringRequired within parentTag label

Retrieve a list of ATS applications — 200 response body — data item current application interview plan stage

FieldTypePresenceDescription and constraints
$objectRootCurrent interview plan stage information for the application
application_idstringRequired within parentApplication unique identifier
Format: uuid
idstringRequired within parentApplication interview plan stage unique identifier
Format: uuid
interview_plan_stageModelRequired within parentExpand Retrieve a list of ATS applications — 200 response body — data item current application interview plan stage interview plan stage
interview_plan_stage_idstringRequired within parentInterview plan stage unique identifier
Format: uuid

Referenced models: Retrieve a list of ATS applications — 200 response body — data item current application interview plan stage interview plan stage

Retrieve a list of ATS applications — 200 response body — data item current application interview plan stage interview plan stage

FieldTypePresenceDescription and constraints
$objectRoot
category_type_slugstringRequired within parentInterview plan stage category type
default_type_slugJSONRequired within parent
default_type_slug (anyOf 1)stringAlternativeInterview plan stage default type slug
default_type_slug (anyOf 2)nullAlternativeInterview plan stage default type slug
idstringRequired within parentInterview plan stage unique identifier
Format: uuid
namestringRequired within parentInterview plan stage name
position_numberJSONRequired within parent
position_number (anyOf 1)JSONAlternative
position_number (anyOf 1) (anyOf 1)integerAlternativeOrdinal position of the stage in its job pipeline. Ranges are stable across organizations: below 2000 for lead stages, 2000 for application review, 2001-2998 for the customer-defined interview rounds, 2999 for offer, 3000 and above for hired and archived.
position_number (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
position_number (anyOf 2)nullAlternativeOrdinal position of the stage in its job pipeline. Ranges are stable across organizations: below 2000 for lead stages, 2000 for application review, 2001-2998 for the customer-defined interview rounds, 2999 for offer, 3000 and above for hired and archived.

Retrieve a list of ATS applications — 200 response body — data item job

FieldTypePresenceDescription and constraints
$objectRootJob information for the application
idstringRequired within parentJob unique identifier
Format: uuid
titlestringRequired within parentJob title

Retrieve a list of ATS applications — 200 response body — data item job employment type

FieldTypePresenceDescription and constraints
$objectRootEmployment type information for the job
employment_typeModelRequired within parentExpand Retrieve a list of ATS applications — 200 response body — data item job employment type employment type
idstringRequired within parentJob employment type unique identifier
Format: uuid

Referenced models: Retrieve a list of ATS applications — 200 response body — data item job employment type employment type

Retrieve a list of ATS applications — 200 response body — data item job employment type employment type

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentEmployment type unique identifier
Format: uuid
namestringRequired within parentEmployment type name

Retrieve a list of ATS applications — 200 response body — data item job posting id, title

FieldTypePresenceDescription and constraints
$objectRootJob posting information (if application came through a posting)
idstringRequired within parentJob posting unique identifier
Format: uuid
titlestringRequired within parentJob posting title

Retrieve a list of ATS applications — 200 response body — data item stage history item

FieldTypePresenceDescription and constraints
$objectRootOne visit of the application to an interview plan stage, in chronological order
entered_atstringRequired within parentTimestamp when the application entered this stage
Format: date-time
exited_atJSONRequired within parent
exited_at (anyOf 1)stringAlternativeTimestamp when the application left this stage; null while the application is still in it
Format: date-time
exited_at (anyOf 2)nullAlternativeTimestamp when the application left this stage; null while the application is still in it
Format: date-time
idstringRequired within parentIdentifier of the stage history record
Format: uuid
interview_plan_stageModelRequired within parentExpand Retrieve a list of ATS applications — 200 response body — data item stage history item interview plan stage
The interview plan stage this history record refers to
is_currentbooleanRequired within parentWhether this is the stage the application is currently in
moved_by_hris_organization_user_idJSONRequired within parent
moved_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user who moved the application into this stage; null for automated moves
Format: uuid
moved_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user who moved the application into this stage; null for automated moves
Format: uuid

Referenced models: Retrieve a list of ATS applications — 200 response body — data item stage history item interview plan stage

Retrieve a list of ATS applications — 200 response body — data item stage history item interview plan stage

FieldTypePresenceDescription and constraints
$objectRootThe interview plan stage this history record refers to
category_type_slugstringRequired within parentStage category: lead, active or completed
default_type_slugJSONRequired within parent
default_type_slug (anyOf 1)stringAlternativeSystem stage type (e.g. new_lead, application_review, offer, hired, archived); null for custom stages
default_type_slug (anyOf 2)nullAlternativeSystem stage type (e.g. new_lead, application_review, offer, hired, archived); null for custom stages
idstringRequired within parentInterview plan stage identifier
Format: uuid
namestringRequired within parentCustomer-defined stage name
position_numberJSONRequired within parent
position_number (anyOf 1)integerAlternativePosition of the stage in the interview plan
position_number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a list of ATS applications — request body — query job criterias matchings item

FieldTypePresenceDescription and constraints
$objectRoot
is_matchedstringRequired within parentOne of: MATCHED, NOT_MATCHED, UNDECIDED
job_criteria_idstringRequired within parentFormat: uuid

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.