Skip to content

Deel: ATS schemas (part 1)

94 Deel schemas with complete fields and constraints.

← ATS operations · All schemas

Add content to the private note of a job — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add content to the private note of a job — 201 response body — data
The job note after the write

Referenced models: Add content to the private note of a job — 201 response body — data

Add content to the private note of a job — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe job note after the write
created_atstringRequired within parentThe timestamp when the note was created
Format: date-time
created_by_hris_organization_user_idJSONRequired within parent
created_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user ID of the user who created the note
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user ID of the user who created the note
Format: uuid
idstringRequired within parentThe unique identifier of the job note
Format: uuid
richtext_contentstringRequired within parentThe content of the note in rich text HTML format
updated_atstringRequired within parentThe timestamp when the note was last changed
Format: date-time
updated_by_hris_organization_user_idJSONRequired within parent
updated_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user ID of the user who last changed the note
Format: uuid
updated_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user ID of the user who last changed the note
Format: uuid

Add content to the private note of a job — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
expected_updated_atstring or nullOptionalOptional precondition: the note's updated_at as last read, or null when the job had no note. If the note changed since, nothing is written and a 409 precondition_failed is returned.
Format: date-time
richtext_contentstringRequired within parentRich text HTML to add. It becomes the note when the job has none, otherwise it is appended after the existing content.
Minimum length: 1

Add note to a candidate — ats add Note To Acandidate — 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
Maximum length: 10000

Add note to a candidate — ats add Note To Candidate — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add note to a candidate — ats add Note To Candidate — 201 response body — data
The created candidate note

Referenced models: Add note to a candidate — ats add Note To Candidate — 201 response body — data

Add note to a candidate — ats add Note To Candidate — 201 response body — data

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

Add note to a candidate — ats add Note To Candidate — request body — body data

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

Create a stage move for an application — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a stage move for an application — 201 response body — data
The application's new current interview plan stage record

Referenced models: Create a stage move for an application — 201 response body — data

Create a stage move for an application — 201 response body — data

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

Create a stage move for an application — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
applicable_job_activitiesarrayOptionalOptional array of job activities to trigger when the application enters the 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 Create a stage move for an application — request body — body data applicable job activities item
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 move the application to. Stages of the completed category are rejected.
Format: uuid

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

Create a stage move for an application — 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
job_activity_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 a stage move for an application — request body — body data applicable job activities item participants item

FieldTypePresenceDescription and constraints
$objectRoot
participant_hris_organization_user_idstringRequired within parentThe HRIS organization user ID of the participant
Format: uuid
role_slugstringRequired within parentThe role of the participant in the activity
One of: REVIEWER, INTERVIEWER

Create an email draft to a candidate — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create an email draft to a candidate — 201 response body — data
The new draft, rendered as it would be sent

Referenced models: Create an email draft to a candidate — 201 response body — data

Create an email draft to a candidate — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe new draft, rendered as it would be sent
application_idJSONRequired within parent
application_id (anyOf 1)stringAlternativeThe application the draft is about, or null for a draft about the candidate only
Format: uuid
application_id (anyOf 2)nullAlternativeThe application the draft is about, or null for a draft about the candidate only
Format: uuid
attachmentsarrayRequired within parentFiles attached to the draft
attachments[]ModelEach itemExpand Create an email draft to a candidate — 201 response body — data attachments item
bccarrayRequired within parentBCC recipients, resolved to addresses
bcc[]stringEach itemFormat: email
bodystringRequired within parentThe rich text HTML body with its placeholders filled in
ccarrayRequired within parentCC recipients, resolved to addresses
cc[]stringEach itemFormat: email
fromstringRequired within parentThe sender the email goes out as: the author's connected mailbox when they have one, otherwise the organization's sender
idstringRequired within parentThe unique identifier of the email draft
Format: uuid
subjectstringRequired within parentThe subject with its placeholders filled in
toarrayRequired within parentPrimary recipients, with dynamic recipients such as the candidate resolved to addresses
to[]stringEach itemFormat: email
unresolved_placeholdersarrayRequired within parentPlaceholders left unfilled in the subject or body. The draft cannot be sent while any remain.
unresolved_placeholders[]stringEach item
updated_atstringRequired within parentThe timestamp when the draft was last changed
Format: date-time

Referenced models: Create an email draft to a candidate — 201 response body — data attachments item

Create an email draft to a candidate — 201 response body — data attachments item

FieldTypePresenceDescription and constraints
$objectRoot
file_namestringRequired within parentThe name of the attached file
idstringRequired within parentThe unique identifier of the attachment
Format: uuid

Create an email draft to a candidate — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
application_idstringOptionalThe application of the candidate the draft is about. Required unless the caller is an ATS admin, since access to emails is granted per job.
Format: uuid
bccarrayOptionalBCC recipients. Each entry is an email address, or a dynamic recipient resolved when the draft is rendered: CANDIDATE, HIRING_MEMBERS, INTERVIEWERS, RECRUITERS or HIRING_MANAGERS.
bcc[]stringEach item
bodystringRequired within parentThe rich text HTML body. May contain placeholders, filled when the draft is rendered.
ccarrayOptionalCC recipients. Each entry is an email address, or a dynamic recipient resolved when the draft is rendered: CANDIDATE, HIRING_MEMBERS, INTERVIEWERS, RECRUITERS or HIRING_MANAGERS.
cc[]stringEach item
subjectstringRequired within parentThe subject. May contain placeholders such as ${{candidate.firstName}}, filled when the draft is rendered.
Maximum length: 1000
toarrayRequired within parentPrimary recipients. Each entry is an email address, or a dynamic recipient resolved when the draft is rendered: CANDIDATE, HIRING_MEMBERS, INTERVIEWERS, RECRUITERS or HIRING_MANAGERS.
to[]stringEach item

Create an offer for an application in the offer stage — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create an offer for an application in the offer stage — 201 response body — data
The created offer

Referenced models: Create an offer for an application in the offer stage — 201 response body — data

Create an offer for an application in the offer stage — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe created offer
application_interview_plan_stage_idstringRequired within parentID of the application's offer stage record the offer belongs to
Format: uuid
approval_policy_idJSONRequired within parent
approval_policy_id (anyOf 1)stringAlternativeID of the approval policy applied to the offer
Format: uuid
approval_policy_id (anyOf 2)nullAlternativeID of the approval policy applied to the offer
Format: uuid
approval_request_idJSONRequired within parent
approval_request_id (anyOf 1)stringAlternativeID of the approval request opened for an approval rule
Format: uuid
approval_request_id (anyOf 2)nullAlternativeID of the approval request opened for an approval rule
Format: uuid
approval_rule_idJSONRequired within parent
approval_rule_id (anyOf 1)stringAlternativeID of the approval rule applied to the offer
Format: uuid
approval_rule_id (anyOf 2)nullAlternativeID of the approval rule applied to the offer
Format: uuid
created_atstringRequired within parentTimestamp when the offer was created
Format: date-time
idstringRequired within parentID of the created offer
Format: uuid
offer_statusstringRequired within parentStatus of the new offer: WAITING_FOR_APPROVAL when an approval applies, otherwise CREATED
Known values: CREATED, WAITING_FOR_APPROVAL

Create an offer for an application in the offer stage — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
additional_detailsstring or nullOptionalAdditional details shown with the offer
approval_policy_idstring or nullOptionalID of the approval policy the offer goes through, for organizations that use approval policies
Format: uuid
approval_rule_idstring or nullOptionalID of the approval rule the offer goes through, for organizations that use approval rules
Format: uuid
compensation_amountnumberRequired within parentCompensation amount for the period
Format: double
compensation_currencystringRequired within parentISO 4217 currency code of the compensation
compensation_period_slugstringOptionalPeriod the compensation amount covers
One of: annually, monthly, semimonthly, biweekly, weekly, daily, hourly
country_codestringRequired within parentISO 3166-1 alpha-2 code of the country the candidate will work in
Format: country-code
expires_atstring or nullOptionalDate the offer expires once sent if the candidate has not answered
Format: date
job_titlestringRequired within parentJob title offered to the candidate
offer_letter_template_idstring or nullOptionalID of the offer letter template to attach. Archived templates are rejected.
Format: uuid
opening_idstring or nullOptionalID of the job opening the offer fills
Format: uuid
start_datestringRequired within parentProposed start date of the candidate
Format: date-time
worker_typestringRequired within parentHow the candidate will be hired
One of: CONTRACTOR_FIXED, CONTRACTOR_PAY_AS_YOU_GO, CONTRACTOR_MILESTONE, DIRECT_EMPLOYEE, EOR_EMPLOYEE, GLOBAL_PAYROLL_EMPLOYEE, PEO_EMPLOYEE, PWAC

Generate a preview of an ATS email template — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Generate a preview of an ATS email template — 200 response body — data

Referenced models: Generate a preview of an ATS email template — 200 response body — data

Generate a preview of an ATS email template — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
bodystringRequired within parentRendered body as sanitized HTML. Unresolved placeholders are left in place.
subjectstringRequired within parentRendered subject as plain text. Unresolved placeholders are left in place.
unresolved_placeholdersarrayRequired within parentDistinct placeholders that could not be filled, as they appear in the text. interview.*, questionnaire.link, document.*, application_form.link and referrer.fullName are only supplied when the email is sent, so they are always listed.
unresolved_placeholders[]stringEach item

Get an interview transcript — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of transcript segments, ordered by the time they were spoken.
data[]ModelEach itemExpand Get an interview transcript — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available beyond the current page.
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 transcript segments for this interview.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get an interview transcript — 200 response body — data item

Get an interview transcript — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the transcript segment.
Format: uuid
is_meeting_hostbooleanRequired within parentWhether the speaker was the meeting host.
offset_secondsJSONRequired within parent
offset_seconds (anyOf 1)integerAlternativeSeconds elapsed since the start of the interview when the segment was spoken.
offset_seconds (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
speaker_namestringRequired within parentName of the meeting participant who spoke this segment, as captured by the transcription bot.
spoken_atstringRequired within parentISO 8601 datetime when the segment was spoken.
Format: date-time
textstringRequired within parentVerbatim text of the spoken segment. May contain special-category data the candidate volunteered.

Get interview notes — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of interview notes, oldest first.
data[]ModelEach itemExpand Get interview notes — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available beyond the current page.
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 notes for this interview, across all pages.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get interview notes — 200 response body — data item

Get interview notes — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
content_textstringRequired within parentAI-generated note text summarising part of the interview. Condenses what the candidate said and may contain personal data they volunteered.
created_atstringRequired within parentISO 8601 datetime when the note was generated.
Format: date-time
idstringRequired within parentUnique identifier of the interview note.
Format: uuid
titlestringRequired within parentShort AI-generated title of the note. Derived from the interview conversation.
transcription_content_idJSONRequired within parent
transcription_content_id (anyOf 1)stringAlternativeIdentifier of the transcript segment the note was generated from, matching a segment id of the interview transcript; null when the note is not linked to a single segment.
Format: uuid
transcription_content_id (anyOf 2)nullAlternativeIdentifier of the transcript segment the note was generated from, matching a segment id of the interview transcript; null when the note is not linked to a single segment.
Format: uuid
type_slugstringRequired within parentKind of note: SUMMARY (overall summary), KEY_POINT (a highlight) or OUTLINE (an agenda item of the conversation).
Known values: SUMMARY, KEY_POINT, OUTLINE

List available slots for an interview — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentAvailable slots in the window, earliest first
data[]ModelEach itemExpand List available slots for an interview — 200 response body — data item
has_morebooleanRequired within parentAlways false: every slot in the window is returned at once.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeAlways null: every slot in the window is returned at once.
next_cursor (anyOf 2)nullAlternativeAlways null: every slot in the window is returned at once.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeNumber of available slots in the window.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List available slots for an interview — 200 response body — data item

List available slots for an interview — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
end_timestringRequired within parentEnd of the available slot
Format: date-time
start_timestringRequired within parentStart of the available slot
Format: date-time

List email drafts to a candidate as they would be sent — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentThe caller's own drafts to the candidate, most recently changed first, rendered as they would be sent
data[]ModelEach itemExpand List email drafts to a candidate as they would be sent — 200 response body — data item
has_morebooleanRequired within parentWhether the caller has more drafts to the candidate than the page holds
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeAlways null: the most recently changed drafts are returned in a single page.
next_cursor (anyOf 2)nullAlternativeAlways null: the most recently changed drafts are returned in a single page.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeNumber of the caller's drafts to the candidate
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List email drafts to a candidate as they would be sent — 200 response body — data item

List email drafts to a candidate as they would be sent — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
application_idJSONRequired within parent
application_id (anyOf 1)stringAlternativeThe application the draft is about, or null for a draft about the candidate only
Format: uuid
application_id (anyOf 2)nullAlternativeThe application the draft is about, or null for a draft about the candidate only
Format: uuid
attachmentsarrayRequired within parentFiles attached to the draft
attachments[]ModelEach itemExpand Create an email draft to a candidate — 201 response body — data attachments item
bccarrayRequired within parentBCC recipients, resolved to addresses
bcc[]stringEach itemFormat: email
bodystringRequired within parentThe rich text HTML body with its placeholders filled in
ccarrayRequired within parentCC recipients, resolved to addresses
cc[]stringEach itemFormat: email
fromstringRequired within parentThe sender the email goes out as: the author's connected mailbox when they have one, otherwise the organization's sender
idstringRequired within parentThe unique identifier of the email draft
Format: uuid
subjectstringRequired within parentThe subject with its placeholders filled in
toarrayRequired within parentPrimary recipients, with dynamic recipients such as the candidate resolved to addresses
to[]stringEach itemFormat: email
unresolved_placeholdersarrayRequired within parentPlaceholders left unfilled in the subject or body. The draft cannot be sent while any remain.
unresolved_placeholders[]stringEach item
updated_atstringRequired within parentThe timestamp when the draft was last changed
Format: date-time

Referenced models: Create an email draft to a candidate — 201 response body — data attachments item

List feedbacks for an application — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of application feedbacks.
data[]ModelEach itemExpand List feedbacks for an application — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available beyond the current page.
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 feedbacks for this application.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List feedbacks for an application — 200 response body — data item

List feedbacks for an application — 200 response body — data / item / reviewer / reviewer_profile / type: CLIENT, WORKER

FieldTypePresenceDescription and constraints
$objectRoot
countryJSONOptional
country (anyOf 1)stringAlternativeISO 3166-1 alpha-2 country code.
country (anyOf 2)nullAlternativeISO 3166-1 alpha-2 country code.
first_namestringOptionalFirst name.
full_namestringOptionalFull name.
hris_organization_user_idstringOptionalHRIS organization user ID.
Format: uuid
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeJob title.
job_title (anyOf 2)nullAlternativeJob title.
last_namestringOptionalLast name.
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeProfile picture URL.
pic_url (anyOf 2)nullAlternativeProfile picture URL.
typestringOptionalParticipant type within the organization.
Known values: CLIENT, WORKER
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeWork email.
Format: email
work_email (anyOf 2)nullAlternativeWork email.
Format: email

List feedbacks for an application — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
activity_typeJSONOptional
activity_type (anyOf 1)stringAlternativeType slug of the interview activity.
activity_type (anyOf 2)nullAlternativeType slug of the interview activity.
application_activity_idstringRequired within parentActivity the feedback belongs to.
Format: uuid
created_atstringRequired within parentISO 8601 datetime when the feedback record was created.
Format: date-time
dismissal_reasonJSONOptionalReason the reviewer selected when dismissing the feedback request. Null when the request was dismissed from the reviewer's Deel Tasks list, which records no reason.
dismissal_reason (anyOf 1)ModelAlternativeExpand List feedbacks for an application — 200 response body — data item dismissal reason id, label
dismissal_reason (anyOf 2)nullAlternative
dismissed_atJSONOptional
dismissed_at (anyOf 1)stringAlternativeISO 8601 datetime when the reviewer dismissed the feedback request.
Format: date-time
dismissed_at (anyOf 2)nullAlternativeISO 8601 datetime when the reviewer dismissed the feedback request.
Format: date-time
feedback_formModelRequired within parentExpand List feedbacks for an application — 200 response body — data item feedback form
Feedback form template used for this feedback.
form_responsesJSONOptional
form_responses (anyOf 1)arrayAlternativeSubmitted form question/answer pairs from FormBuilder.
form_responses (anyOf 1)[]ModelEach itemExpand List feedbacks for an application — 200 response body — data item form responses null item
form_responses (anyOf 2)nullAlternativeSubmitted form question/answer pairs from FormBuilder.
form_responses (anyOf 2)[]ModelEach itemExpand List feedbacks for an application — 200 response body — data item form responses null item
idstringRequired within parentUnique identifier of the feedback record.
Format: uuid
overall_recommendationJSONOptionalOverall recommendation selected by the reviewer.
overall_recommendation (anyOf 1)ModelAlternativeExpand List feedbacks for an application — 200 response body — data item overall recommendation Overall recommendation selected by the reviewer
overall_recommendation (anyOf 2)nullAlternative
reviewerModelRequired within parentExpand List feedbacks for an application — 200 response body — data item reviewer
Reviewer who provided the feedback.
revocation_reason_enumJSONOptionalWhy the system revoked the feedback request.
revocation_reason_enum (anyOf 1)stringAlternativeWhy the system revoked the feedback request.
Known values: JOB_CLOSED, APPLICATION_COMPLETED
revocation_reason_enum (anyOf 2)nullAlternative
revoked_atJSONOptional
revoked_at (anyOf 1)stringAlternativeISO 8601 datetime when the system revoked the feedback request.
Format: date-time
revoked_at (anyOf 2)nullAlternativeISO 8601 datetime when the system revoked the feedback request.
Format: date-time
scheduled_interview_idJSONRequired within parent
scheduled_interview_id (anyOf 1)stringAlternativeScheduled interview the feedback was collected for (see GET /rest/ats/interviews); null for non-interview activities.
Format: uuid
scheduled_interview_id (anyOf 2)nullAlternativeScheduled interview the feedback was collected for (see GET /rest/ats/interviews); null for non-interview activities.
Format: uuid
stage_nameJSONOptional
stage_name (anyOf 1)stringAlternativeName of the interview plan stage.
stage_name (anyOf 2)nullAlternativeName of the interview plan stage.
statusstringRequired within parentSubmission status of the feedback. DISMISSED means the reviewer dismissed the request with a reason. REVOKED means the system withdrew it because the job closed or the application reached a terminal stage.
Known values: SUBMITTED, NOT_SUBMITTED, DISMISSED, REVOKED
submitted_atJSONOptional
submitted_at (anyOf 1)stringAlternativeISO 8601 datetime when the feedback was submitted.
Format: date-time
submitted_at (anyOf 2)nullAlternativeISO 8601 datetime when the feedback was submitted.
Format: date-time

Referenced models: List feedbacks for an application — 200 response body — data item dismissal reason id, label, List feedbacks for an application — 200 response body — data item feedback form, List feedbacks for an application — 200 response body — data item form responses null item, List feedbacks for an application — 200 response body — data item overall recommendation Overall recommendation selected by the reviewer, List feedbacks for an application — 200 response body — data item reviewer

List feedbacks for an application — 200 response body — data item dismissal reason id, label

FieldTypePresenceDescription and constraints
$objectRootReason the reviewer selected when dismissing the feedback request. Null when the request was dismissed from the reviewer's Deel Tasks list, which records no reason.
idstringOptionalUnique identifier of the reason.
Format: uuid
labelstringOptionalLabel of the reason.

List feedbacks for an application — 200 response body — data item feedback form

FieldTypePresenceDescription and constraints
$objectRootFeedback form template used for this feedback.
idstringRequired within parentUnique identifier of the feedback form.
Format: uuid
titlestringRequired within parentTitle of the feedback form.

List feedbacks for an application — 200 response body — data item form responses null item

FieldTypePresenceDescription and constraints
$objectRoot
answerModelRequired within parentExpand List feedbacks for an application — 200 response body — data item form responses null item answer
Answer value; shape varies by question type (string, number, array, or object).
question_textstringRequired within parentText of the feedback form question.
question_typestringRequired within parentType of the question field.

Referenced models: List feedbacks for an application — 200 response body — data item form responses null item answer

List feedbacks for an application — 200 response body — data item form responses null item answer

FieldTypePresenceDescription and constraints
$JSONRootAnswer value; shape varies by question type (string, number, array, or object).
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 3)booleanAlternative
$ (anyOf 4)arrayAlternative
$ (anyOf 4)[]JSONEach itemAny type
$ (anyOf 5)objectAlternativeAdditional keys: see wildcard field
$ (anyOf 5).*JSONAdditional keysAny type

List feedbacks for an application — 200 response body — data item overall recommendation Overall recommendation selected by the reviewer

FieldTypePresenceDescription and constraints
$objectRootOverall recommendation selected by the reviewer.
scale_item_idstringOptionalUnique identifier of the selected feedback scale item.
Format: uuid
scale_item_labelstringOptionalDisplay label of the selected scale item.
scale_titleJSONOptional
scale_title (anyOf 1)stringAlternativeTitle of the feedback scale.
scale_title (anyOf 2)nullAlternativeTitle of the feedback scale.

List feedbacks for an application — 200 response body — data item reviewer

FieldTypePresenceDescription and constraints
$objectRootReviewer who provided the feedback.
participant_hris_organization_user_idstringRequired within parentHRIS organization user ID of the reviewer.
Format: uuid
reviewer_profileJSONOptional
reviewer_profile (anyOf 1)ModelAlternativeExpand List feedbacks for an application — 200 response body — data / item / reviewer / reviewer_profile / type: CLIENT, WORKER
reviewer_profile (anyOf 2)nullAlternative

Referenced models: List feedbacks for an application — 200 response body — data / item / reviewer / reviewer_profile / type: CLIENT, WORKER

List interview and evaluation feedback across the organization — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of feedback records.
data[]ModelEach itemExpand List interview and evaluation feedback across the organization — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available beyond the current page.
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 feedback records matching the filters.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List interview and evaluation feedback across the organization — 200 response body — data item

List interview and evaluation feedback across the organization — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
activity_typeJSONRequired within parentKind of activity the feedback belongs to.
activity_type (anyOf 1)stringAlternativeKind of activity the feedback belongs to.
Known values: INTERVIEW_SCHEDULING, APPLICATION_EVALUATION, EXERCISE, QUESTIONNAIRE, EMAIL_SENDING
activity_type (anyOf 2)nullAlternative
applicationModelRequired within parentExpand List interview and evaluation feedback across the organization — 200 response body — data item application
Application the feedback is about.
application_activity_idstringRequired within parentActivity the feedback belongs to.
Format: uuid
application_interview_plan_stage_idJSONRequired within parent
application_interview_plan_stage_id (anyOf 1)stringAlternativeApplication stage record the activity belongs to.
Format: uuid
application_interview_plan_stage_id (anyOf 2)nullAlternativeApplication stage record the activity belongs to.
Format: uuid
created_atstringRequired within parentWhen the feedback request was created.
Format: date-time
feedback_formModelRequired within parentExpand List interview and evaluation feedback across the organization — 200 response body — data item feedback form
Scorecard template used.
form_responsesJSONOptional
form_responses (anyOf 1)arrayAlternativeSubmitted scorecard answers. Present only when include=FORM_RESPONSES is requested; null when nothing was submitted.
form_responses (anyOf 1)[]ModelEach itemExpand List interview and evaluation feedback across the organization — 200 response body — data item form responses null item
form_responses (anyOf 2)nullAlternativeSubmitted scorecard answers. Present only when include=FORM_RESPONSES is requested; null when nothing was submitted.
form_responses (anyOf 2)[]ModelEach itemExpand List interview and evaluation feedback across the organization — 200 response body — data item form responses null item
idstringRequired within parentUnique identifier of the feedback record.
Format: uuid
interview_plan_stageJSONRequired within parentInterview plan stage the activity belongs to.
interview_plan_stage (anyOf 1)ModelAlternativeExpand List interview and evaluation feedback across the organization — 200 response body — data item interview plan stage Interview plan stage the activity belongs to
interview_plan_stage (anyOf 2)nullAlternative
overall_recommendationJSONRequired within parentThe recommendation the reviewer selected; null while pending.
overall_recommendation (anyOf 1)ModelAlternativeExpand List interview and evaluation feedback across the organization — 200 response body — data item overall recommendation scale id, scale item id, scale item label, scale item position, scale items count, scale title
overall_recommendation (anyOf 2)nullAlternative
reviewerModelRequired within parentExpand List interview and evaluation feedback across the organization — 200 response body — data item reviewer
Reviewer who owes or provided the feedback.
scheduled_interviewJSONRequired within parentThe interview the feedback was collected for; null for non-interview activities.
scheduled_interview (anyOf 1)ModelAlternativeExpand List interview and evaluation feedback across the organization — 200 response body — data item scheduled interview ends at, has happened, id, starts at, status enum
scheduled_interview (anyOf 2)nullAlternative
statusstringRequired within parentSubmission status.
Known values: SUBMITTED, NOT_SUBMITTED
submitted_atJSONRequired within parent
submitted_at (anyOf 1)stringAlternativeWhen the feedback was submitted; null while still owed.
Format: date-time
submitted_at (anyOf 2)nullAlternativeWhen the feedback was submitted; null while still owed.
Format: date-time
updated_atstringRequired within parentWhen the feedback was last updated.
Format: date-time

Referenced models: List interview and evaluation feedback across the organization — 200 response body — data item feedback form, List interview and evaluation feedback across the organization — 200 response body — data item interview plan stage Interview plan stage the activity belongs to, List interview and evaluation feedback across the organization — 200 response body — data item application, List interview and evaluation feedback across the organization — 200 response body — data item form responses null item, List interview and evaluation feedback across the organization — 200 response body — data item overall recommendation scale id, scale item id, scale item label, scale item position, scale items count, scale title, List interview and evaluation feedback across the organization — 200 response body — data item reviewer, List interview and evaluation feedback across the organization — 200 response body — data item scheduled interview ends at, has happened, id, starts at, status enum

List interview and evaluation feedback across the organization — 200 response body — data item application

FieldTypePresenceDescription and constraints
$objectRootApplication the feedback is about.
candidateModelRequired within parentExpand List interview and evaluation feedback across the organization — 200 response body — data item application candidate
Candidate on the application.
current_application_interview_plan_stageJSONRequired within parentWhere the candidate is now.
current_application_interview_plan_stage (anyOf 1)ModelAlternativeExpand List interview and evaluation feedback across the organization — 200 response body — data item application current application interview plan stage Where the candidate is now
current_application_interview_plan_stage (anyOf 2)nullAlternative
idstringRequired within parentApplication identifier.
Format: uuid
jobModelRequired within parentExpand List interview and evaluation feedback across the organization — 200 response body — data item application job
Job of the application.

Referenced models: List interview and evaluation feedback across the organization — 200 response body — data item application candidate, List interview and evaluation feedback across the organization — 200 response body — data item application job, List interview and evaluation feedback across the organization — 200 response body — data item application current application interview plan stage Where the candidate is now

List interview and evaluation feedback across the organization — 200 response body — data item application candidate

FieldTypePresenceDescription and constraints
$objectRootCandidate on the application.
emailstringRequired within parentCandidate email.
Format: email
first_namestringRequired within parentCandidate first name.
idstringRequired within parentCandidate identifier.
Format: uuid
last_namestringRequired within parentCandidate last name.

List interview and evaluation feedback across the organization — 200 response body — data item application current application interview plan stage Where the candidate is now

FieldTypePresenceDescription and constraints
$objectRootWhere the candidate is now.
idstringRequired within parentCurrent application stage record.
Format: uuid
interview_plan_stageJSONRequired within parentThe current interview plan stage.
interview_plan_stage (anyOf 1)ModelAlternativeExpand List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage interview plan stage The current interview plan stage
interview_plan_stage (anyOf 2)nullAlternative

Referenced models: List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage interview plan stage The current interview plan stage

List interview and evaluation feedback across the organization — 200 response body — data item application job

FieldTypePresenceDescription and constraints
$objectRootJob of the application.
idstringRequired within parentJob identifier.
Format: uuid
titlestringRequired within parentJob title.

List interview and evaluation feedback across the organization — 200 response body — data item feedback form

FieldTypePresenceDescription and constraints
$objectRootScorecard template used.
idstringRequired within parentFeedback form identifier.
Format: uuid
titlestringRequired within parentFeedback form title.

List interview and evaluation feedback across the organization — 200 response body — data item form responses null item

FieldTypePresenceDescription and constraints
$objectRoot
answerModelRequired within parentExpand List feedbacks for an application — 200 response body — data item form responses null item answer
Answer value; shape varies by question type (string, number, array, or object).
question_textstringRequired within parentText of the scorecard question.
question_typestringRequired within parentType of the question field.

Referenced models: List feedbacks for an application — 200 response body — data item form responses null item answer

List interview and evaluation feedback across the organization — 200 response body — data item interview plan stage Interview plan stage the activity belongs to

FieldTypePresenceDescription and constraints
$objectRootInterview plan stage the activity belongs to.
category_type_slugstringRequired within parentStage category: lead, active or completed.
idstringRequired within parentInterview plan stage identifier.
Format: uuid
namestringRequired within parentCustomer-defined stage name.

List interview and evaluation feedback across the organization — 200 response body — data item overall recommendation scale id, scale item id, scale item label, scale item position, scale items count, scale title

FieldTypePresenceDescription and constraints
$objectRootThe recommendation the reviewer selected; null while pending.
scale_idstringRequired within parentFeedback scale identifier.
Format: uuid
scale_item_idstringRequired within parentSelected scale item.
Format: uuid
scale_item_labelstringRequired within parentLabel of the selected scale item.
scale_item_positionJSONRequired within parent
scale_item_position (anyOf 1)integerAlternativeZero-based position of the selected item within its scale, lowest first — comparable across labels.
scale_item_position (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
scale_items_countJSONRequired within parent
scale_items_count (anyOf 1)integerAlternativeNumber of items in the scale.
scale_items_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
scale_titleJSONRequired within parent
scale_title (anyOf 1)stringAlternativeFeedback scale title.
scale_title (anyOf 2)nullAlternativeFeedback scale title.

List interview and evaluation feedback across the organization — 200 response body — data item reviewer

FieldTypePresenceDescription and constraints
$objectRootReviewer who owes or provided the feedback.
participant_hris_organization_user_idstringRequired within parentHRIS organization user ID of the reviewer.
Format: uuid
reviewer_profileJSONOptional
reviewer_profile (anyOf 1)ModelAlternativeExpand List feedbacks for an application — 200 response body — data / item / reviewer / reviewer_profile / type: CLIENT, WORKER
reviewer_profile (anyOf 2)nullAlternative

Referenced models: List feedbacks for an application — 200 response body — data / item / reviewer / reviewer_profile / type: CLIENT, WORKER

List interview and evaluation feedback across the organization — 200 response body — data item scheduled interview ends at, has happened, id, starts at, status enum

FieldTypePresenceDescription and constraints
$objectRootThe interview the feedback was collected for; null for non-interview activities.
ends_atJSONRequired within parent
ends_at (anyOf 1)stringAlternativeInterview end.
Format: date-time
ends_at (anyOf 2)nullAlternativeInterview end.
Format: date-time
has_happenedbooleanRequired within parentTrue when the interview took place; combine with status NOT_SUBMITTED to find overdue scorecards.
idstringRequired within parentScheduled interview identifier.
Format: uuid
starts_atJSONRequired within parent
starts_at (anyOf 1)stringAlternativeInterview start.
Format: date-time
starts_at (anyOf 2)nullAlternativeInterview start.
Format: date-time
status_enumstringRequired within parentInterview status.

List interview plan stages of a job with pipeline counts — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentStages of the job's interview plan, in pipeline order.
data[]ModelEach itemExpand List interview plan stages of a job with pipeline counts — 200 response body — data item
has_morebooleanRequired within parentAlways false; the list is not paginated.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeAlways null; the list is not paginated.
next_cursor (anyOf 2)nullAlternativeAlways null; the list is not paginated.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeNumber of stages.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List interview plan stages of a job with pipeline counts — 200 response body — data item

List interview plan stages of a job with pipeline counts — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRootAn interview plan stage of the job with pipeline counts.
category_type_slugstringRequired within parentStage category.
Known values: LEAD, ACTIVE, COMPLETED
current_applicationsarrayOptionalMost recently moved applications currently in the stage. Present only when include=CURRENT_APPLICATIONS is requested.
current_applications[]ModelEach itemExpand List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item
current_applications_countJSONRequired within parent
current_applications_count (anyOf 1)JSONAlternative
current_applications_count (anyOf 1) (anyOf 1)integerAlternativeApplications currently in this stage; null when the caller may not see the job's applications.
current_applications_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
current_applications_count (anyOf 2)nullAlternativeApplications currently in this stage; null when the caller may not see the job's applications.
default_type_slugJSONRequired within parent
default_type_slug (anyOf 1)stringAlternativeSystem stage type (new_lead, application_review, offer, hired, archived); null for custom stages.
default_type_slug (anyOf 2)nullAlternativeSystem stage type (new_lead, application_review, offer, hired, archived); null for custom stages.
idstringRequired within parentInterview plan stage identifier.
Format: uuid
interview_plan_idstringRequired within parentInterview plan the stage belongs to.
Format: uuid
job_idstringRequired within parentJob the interview plan is attached to.
Format: uuid
namestringRequired within parentCustomer-defined stage name.
position_numberJSONRequired within parent
position_number (anyOf 1)integerAlternativePosition of the stage in the interview plan; lower comes first.
position_number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reached_applications_countJSONRequired within parent
reached_applications_count (anyOf 1)JSONAlternative
reached_applications_count (anyOf 1) (anyOf 1)integerAlternativeApplications that have ever been in this stage, including ones since advanced, hired or archived; null when the caller may not see the job's applications.
reached_applications_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reached_applications_count (anyOf 2)nullAlternativeApplications that have ever been in this stage, including ones since advanced, hired or archived; null when the caller may not see the job's applications.

Referenced models: List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item

List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item

FieldTypePresenceDescription and constraints
$objectRootAn application currently in the stage.
candidateModelRequired within parentExpand List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item candidate
The candidate on the application.
created_atstringRequired within parentWhen the application was created.
Format: date-time
idstringRequired within parentApplication identifier.
Format: uuid
moved_to_current_stage_atstringRequired within parentWhen the application entered this 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]+)?$

Referenced models: List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item candidate

List interview plan stages of a job with pipeline counts — 200 response body — data item current applications item candidate

FieldTypePresenceDescription and constraints
$objectRootThe candidate on the application.
emailstringRequired within parentCandidate email.
Format: email
first_namestringRequired within parentCandidate first name.
idstringRequired within parentCandidate identifier.
Format: uuid
last_namestringRequired within parentCandidate last name.

List interviews across applications — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of interviews.
data[]ModelEach itemExpand List interviews across applications — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available beyond the current page.
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 interviews matching the filters.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List interviews across applications — 200 response body — data item

List interviews across applications — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
applicationModelRequired within parentExpand List interviews across applications — 200 response body — data item application
Application linked to this interview.
application_activityModelRequired within parentExpand List interviews across applications — 200 response body — data item application activity
Interview activity details including configuration and participants.
application_activity_idstringRequired within parentID of the application activity linked to this interview.
Format: uuid
application_interview_plan_stage_idJSONOptional
application_interview_plan_stage_id (anyOf 1)stringAlternativeID of the application stage record the interview belongs to.
Format: uuid
application_interview_plan_stage_id (anyOf 2)nullAlternativeID of the application stage record the interview belongs to.
Format: uuid
cancellation_reasonJSONOptional
cancellation_reason (anyOf 1)stringAlternativeFree-text cancellation reason; null unless cancelled.
cancellation_reason (anyOf 2)nullAlternativeFree-text cancellation reason; null unless cancelled.
cancellation_reason_idJSONOptional
cancellation_reason_id (anyOf 1)stringAlternativeCancellation reason ID (see GET /rest/ats/reasons with reason_group_slug=INTERVIEW_CANCELLATION); null unless cancelled.
Format: uuid
cancellation_reason_id (anyOf 2)nullAlternativeCancellation reason ID (see GET /rest/ats/reasons with reason_group_slug=INTERVIEW_CANCELLATION); null unless cancelled.
Format: uuid
cancelled_atJSONOptional
cancelled_at (anyOf 1)stringAlternativeISO 8601 datetime when the interview was cancelled; null unless cancelled.
Format: date-time
cancelled_at (anyOf 2)nullAlternativeISO 8601 datetime when the interview was cancelled; null unless cancelled.
Format: date-time
created_atstringRequired within parentISO 8601 datetime when the interview record was created.
Format: date-time
created_by_hris_organization_user_idJSONOptional
created_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user who created the interview.
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user who created the interview.
Format: uuid
ends_atJSONOptional
ends_at (anyOf 1)stringAlternativeISO 8601 datetime when the interview ends.
Format: date-time
ends_at (anyOf 2)nullAlternativeISO 8601 datetime when the interview ends.
Format: date-time
has_happenedbooleanOptionalTrue when the interview took place: status SCHEDULED or COMPLETED and the meeting end (or start, when no end is recorded) is in the past. False for cancelled interviews and interviews not yet held.
idstringRequired within parentUnique identifier of the interview.
Format: uuid
interview_plan_stageJSONOptionalThe interview plan stage the interview belongs to, independent of the candidate's current stage.
interview_plan_stage (anyOf 1)ModelAlternativeExpand List interviews across applications — 200 response body — data item interview plan stage category type slug, default type slug, id, name, position number
interview_plan_stage (anyOf 2)nullAlternative
meeting_urlJSONOptional
meeting_url (anyOf 1)stringAlternativeVideo conferencing URL for the interview.
meeting_url (anyOf 2)nullAlternativeVideo conferencing URL for the interview.
starts_atJSONOptional
starts_at (anyOf 1)stringAlternativeISO 8601 datetime when the interview starts.
Format: date-time
starts_at (anyOf 2)nullAlternativeISO 8601 datetime when the interview starts.
Format: date-time
status_enumstringRequired within parentCurrent status of the interview.
Known values: SCHEDULE_NEEDED, LINK_SENT, SLOT_REQUEST_SENT, SLOTS_SUBMITTED, SCHEDULED, RESCHEDULE_REQUESTED, CANCELLED, COMPLETED
timezoneJSONOptional
timezone (anyOf 1)stringAlternativeIANA timezone of the interview.
timezone (anyOf 2)nullAlternativeIANA timezone of the interview.
updated_atstringRequired within parentISO 8601 datetime when the interview record was last updated.
Format: date-time

Referenced models: List interviews across applications — 200 response body — data item application, List interviews across applications — 200 response body — data item application activity, List interviews across applications — 200 response body — data item interview plan stage category type slug, default type slug, id, name, position number

List interviews across applications — 200 response body — data item application

FieldTypePresenceDescription and constraints
$objectRootApplication linked to this interview.
candidateModelRequired within parentExpand List interviews across applications — 200 response body — data item application candidate
Candidate being interviewed.
current_application_interview_plan_stageJSONOptionalThe stage the candidate is in now, which may differ from the stage the interview belongs to.
current_application_interview_plan_stage (anyOf 1)ModelAlternativeExpand List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage
current_application_interview_plan_stage (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the application.
Format: uuid
jobModelRequired within parentExpand List interviews across applications — 200 response body — data item application job
Job linked to the application.

Referenced models: List interviews across applications — 200 response body — data item application job, List interviews across applications — 200 response body — data item application candidate, List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage

List interviews across applications — 200 response body — data item application activity

FieldTypePresenceDescription and constraints
$objectRootInterview activity details including configuration and participants.
application_activity_participationsarrayOptionalList of interviewers participating in this interview.
application_activity_participations[]ModelEach itemExpand List interviews across applications — 200 response body — data item application activity application activity participations item
interview_titleJSONOptional
interview_title (anyOf 1)stringAlternativeTitle of the interview stage.
interview_title (anyOf 2)nullAlternativeTitle of the interview stage.
length_in_minutesJSONOptional
length_in_minutes (anyOf 1)JSONAlternative
length_in_minutes (anyOf 1) (anyOf 1)integerAlternativePlanned interview duration in minutes.
length_in_minutes (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
length_in_minutes (anyOf 2)nullAlternativePlanned interview duration in minutes.

Referenced models: List interviews across applications — 200 response body — data item application activity application activity participations item

List interviews across applications — 200 response body — data item application activity application activity participations item

FieldTypePresenceDescription and constraints
$objectRoot
application_activity_feedbacksarrayOptionalFeedback entries submitted by this participant for the interview.
application_activity_feedbacks[]ModelEach itemExpand List interviews across applications — 200 response body — data item application activity application activity participations item application activity feedbacks item
idstringRequired within parentUnique identifier of the participation record.
Format: uuid
participant_hris_organization_user_idstringRequired within parentHRIS organization user ID of the interviewer.
Format: uuid
participant_hris_organization_user_profileJSONOptional
participant_hris_organization_user_profile (anyOf 1)ModelAlternativeExpand List feedbacks for an application — 200 response body — data / item / reviewer / reviewer_profile / type: CLIENT, WORKER
participant_hris_organization_user_profile (anyOf 2)nullAlternative

Referenced models: List feedbacks for an application — 200 response body — data / item / reviewer / reviewer_profile / type: CLIENT, WORKER, List interviews across applications — 200 response body — data item application activity application activity participations item application activity feedbacks item

List interviews across applications — 200 response body — data item application activity application activity participations item application activity feedbacks item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the feedback record.
Format: uuid
overall_recommendationJSONOptionalThe recommendation the interviewer selected (e.g. "Strong Yes"); null while pending or when the caller may only see their own recommendations.
overall_recommendation (anyOf 1)ModelAlternativeExpand List interviews across applications — 200 response body — data item application activity application activity participations item application activity feedbacks item overall recommendation scale item id, scale item label
overall_recommendation (anyOf 2)nullAlternative
submitted_atJSONOptional
submitted_at (anyOf 1)stringAlternativeISO 8601 datetime when the feedback was submitted; null while it is still pending.
Format: date-time
submitted_at (anyOf 2)nullAlternativeISO 8601 datetime when the feedback was submitted; null while it is still pending.
Format: date-time

Referenced models: List interviews across applications — 200 response body — data item application activity application activity participations item application activity feedbacks item overall recommendation scale item id, scale item label

List interviews across applications — 200 response body — data item application activity application activity participations item application activity feedbacks item overall recommendation scale item id, scale item label

FieldTypePresenceDescription and constraints
$objectRootThe recommendation the interviewer selected (e.g. "Strong Yes"); null while pending or when the caller may only see their own recommendations.
scale_item_idstringRequired within parentFeedback scale item identifier.
Format: uuid
scale_item_labelstringRequired within parentFeedback scale item label.

List interviews across applications — 200 response body — data item application candidate

FieldTypePresenceDescription and constraints
$objectRootCandidate being interviewed.
emailstringRequired within parentEmail address of the candidate.
Format: email
first_namestringRequired within parentFirst name of the candidate.
idstringRequired within parentUnique identifier of the candidate.
Format: uuid
last_namestringRequired within parentLast name of the candidate.
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeProfile picture URL of the candidate.
pic_url (anyOf 2)nullAlternativeProfile picture URL of the candidate.

List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage

FieldTypePresenceDescription and constraints
$objectRootThe stage the candidate is in now, which may differ from the stage the interview belongs to.
idstringRequired within parentIdentifier of the current application stage record.
Format: uuid
interview_plan_stageJSONRequired within parentThe current interview plan stage.
interview_plan_stage (anyOf 1)ModelAlternativeExpand List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage interview plan stage The current interview plan stage
interview_plan_stage (anyOf 2)nullAlternative

Referenced models: List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage interview plan stage The current interview plan stage

List interviews across applications — 200 response body — data item application current application interview plan stage id, interview plan stage interview plan stage The current interview plan stage

FieldTypePresenceDescription and constraints
$objectRootThe current interview plan stage.
idstringRequired within parentInterview plan stage identifier.
Format: uuid
namestringRequired within parentCustomer-defined stage name.

List interviews across applications — 200 response body — data item application job

FieldTypePresenceDescription and constraints
$objectRootJob linked to the application.
idstringRequired within parentUnique identifier of the job.
Format: uuid
titlestringRequired within parentTitle of the job position.

List interviews across applications — 200 response body — data item interview plan stage category type slug, default type slug, id, name, position number

FieldTypePresenceDescription and constraints
$objectRootThe interview plan stage the interview belongs to, independent of the candidate's current stage.
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]+)?$

List job openings — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of openings.
data[]ModelEach itemExpand List job openings — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available beyond the current page.
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 openings matching the filters.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List job openings — 200 response body — data item

List job openings — 200 response body — data / item / filled_by_offer / offer_status_enum: ACCEPTED

FieldTypePresenceDescription and constraints
$objectRootThe accepted offer that filled this opening (latest ACCEPTED offer by update time). Null unless the opening is filled with an accepted offer. Contains no compensation data.
offer_status_enumstringOptionalStatus of the filling offer. This object is only present for the accepted offer that filled the opening, so the value is always ACCEPTED.
Known values: ACCEPTED
start_datestringOptionalStart date from the accepted offer (ISO 8601).
Format: date-time

List job openings — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
compensation_currency_iso_codeJSONOptional
compensation_currency_iso_code (anyOf 1)stringAlternativeISO 4217 currency code for compensation.
compensation_currency_iso_code (anyOf 2)nullAlternativeISO 4217 currency code for compensation.
compensation_periodJSONOptional
compensation_period (anyOf 1)stringAlternativeCompensation period (e.g. yearly, monthly).
compensation_period (anyOf 2)nullAlternativeCompensation period (e.g. yearly, monthly).
created_atstringRequired within parentISO 8601 datetime when the opening was created.
Format: date-time
created_by_hris_organization_user_idJSONOptional
created_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user ID of the user who created this opening.
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user ID of the user who created this opening.
Format: uuid
employment_typeJSONOptionalEmployment type details.
employment_type (anyOf 1)ModelAlternativeExpand List job openings — 200 response body — data item employment type Employment type details
employment_type (anyOf 2)nullAlternative
employment_type_idJSONOptional
employment_type_id (anyOf 1)stringAlternativeID of the employment type associated with the opening.
Format: uuid
employment_type_id (anyOf 2)nullAlternativeID of the employment type associated with the opening.
Format: uuid
filled_atJSONOptional
filled_at (anyOf 1)stringAlternativeWhen the opening was filled. Null while it is unfilled.
Format: date-time
filled_at (anyOf 2)nullAlternativeWhen the opening was filled. Null while it is unfilled.
Format: date-time
filled_by_applicationJSONOptionalThe application that filled this opening, including the hired candidate name. Null unless the opening is filled.
filled_by_application (anyOf 1)ModelAlternativeExpand List job openings — 200 response body — data item filled by application candidate, id
filled_by_application (anyOf 2)nullAlternative
filled_by_application_idJSONOptional
filled_by_application_id (anyOf 1)stringAlternativeID of the application that filled this opening, if any.
Format: uuid
filled_by_application_id (anyOf 2)nullAlternativeID of the application that filled this opening, if any.
Format: uuid
filled_by_offerJSONOptionalThe accepted offer that filled this opening (latest ACCEPTED offer by update time). Null unless the opening is filled with an accepted offer. Contains no compensation data.
filled_by_offer (anyOf 1)ModelAlternativeExpand List job openings — 200 response body — data / item / filled_by_offer / offer_status_enum: ACCEPTED
filled_by_offer (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the opening.
Format: uuid
is_confidentialbooleanOptionalWhether this opening is marked confidential.
job_idsarrayOptionalIDs of jobs linked to this opening.
job_ids[]stringEach itemFormat: uuid
locationJSONOptionalLocation details.
location (anyOf 1)ModelAlternativeExpand List job openings — 200 response body — data item location Location details
location (anyOf 2)nullAlternative
location_idJSONOptional
location_id (anyOf 1)stringAlternativeID of the location associated with the opening.
Format: uuid
location_id (anyOf 2)nullAlternativeID of the location associated with the opening.
Format: uuid
max_compensation_amountJSONOptional
max_compensation_amount (anyOf 1)stringAlternativeMaximum compensation amount as a decimal string.
max_compensation_amount (anyOf 2)nullAlternativeMaximum compensation amount as a decimal string.
min_compensation_amountJSONOptional
min_compensation_amount (anyOf 1)stringAlternativeMinimum compensation amount as a decimal string.
min_compensation_amount (anyOf 2)nullAlternativeMinimum compensation amount as a decimal string.
opened_atJSONOptional
opened_at (anyOf 1)stringAlternativeWhen the opening was last opened. Reset when the opening is reopened. Null when it was never opened.
Format: date-time
opened_at (anyOf 2)nullAlternativeWhen the opening was last opened. Reset when the opening is reopened. Null when it was never opened.
Format: date-time
opening_numeric_idJSONRequired within parent
opening_numeric_id (anyOf 1)integerAlternativeNumeric part of the opening identifier (e.g. 42 in ENG-42).
opening_numeric_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
opening_prefixstringRequired within parentPrefix of the opening identifier (e.g. ENG in ENG-42).
opening_type_slugstringRequired within parentWhether this opening is for a new hire or a backfill.
Known values: NEW_HIRE, BACKFILL
recruiter_hris_organization_user_idJSONOptional
recruiter_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user ID of the recruiter responsible for the opening. Null when none is assigned.
Format: uuid
recruiter_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user ID of the recruiter responsible for the opening. Null when none is assigned.
Format: uuid
statusstringRequired within parentCurrent lifecycle status of the opening.
Known values: DRAFT, OPEN, FILLED, CLOSED, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, ARCHIVED
target_hire_dateJSONOptional
target_hire_date (anyOf 1)stringAlternativeTarget date by which the opening should be filled (ISO 8601).
Format: date-time
target_hire_date (anyOf 2)nullAlternativeTarget date by which the opening should be filled (ISO 8601).
Format: date-time
target_start_dateJSONOptional
target_start_date (anyOf 1)stringAlternativeTarget start date for the new hire (ISO 8601).
Format: date-time
target_start_date (anyOf 2)nullAlternativeTarget start date for the new hire (ISO 8601).
Format: date-time
teamJSONOptionalTeam details.
team (anyOf 1)ModelAlternativeExpand List job openings — 200 response body — data item team Team details
team (anyOf 2)nullAlternative
team_idJSONOptional
team_id (anyOf 1)stringAlternativeID of the team this opening belongs to.
Format: uuid
team_id (anyOf 2)nullAlternativeID of the team this opening belongs to.
Format: uuid
titlestringRequired within parentTitle of the job opening.
updated_atstringRequired within parentISO 8601 datetime when the opening was last updated.
Format: date-time
updated_by_hris_organization_user_idJSONOptional
updated_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user ID of the user who last updated this opening.
Format: uuid
updated_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user ID of the user who last updated this opening.
Format: uuid

Referenced models: List job openings — 200 response body — data item employment type Employment type details, List job openings — 200 response body — data item team Team details, List job openings — 200 response body — data item filled by application candidate, id, List job openings — 200 response body — data / item / filled_by_offer / offer_status_enum: ACCEPTED, List job openings — 200 response body — data item location Location details

List job openings — 200 response body — data item employment type Employment type details

FieldTypePresenceDescription and constraints
$objectRootEmployment type details.
idstringOptionalUnique identifier of the employment type.
Format: uuid
namestringOptionalName of the employment type.

List job openings — 200 response body — data item filled by application candidate, id

FieldTypePresenceDescription and constraints
$objectRootThe application that filled this opening, including the hired candidate name. Null unless the opening is filled.
candidateJSONOptionalMinimal identity of the hired candidate.
candidate (anyOf 1)ModelAlternativeExpand List job openings — 200 response body — data item filled by application candidate, id candidate Minimal identity of the hired candidate
candidate (anyOf 2)nullAlternative
idstringOptionalID of the application that filled this opening.
Format: uuid

Referenced models: List job openings — 200 response body — data item filled by application candidate, id candidate Minimal identity of the hired candidate

List job openings — 200 response body — data item filled by application candidate, id candidate Minimal identity of the hired candidate

FieldTypePresenceDescription and constraints
$objectRootMinimal identity of the hired candidate.
first_namestringOptionalFirst name of the hired candidate.
last_namestringOptionalLast name of the hired candidate.

List job openings — 200 response body — data item location Location details

FieldTypePresenceDescription and constraints
$objectRootLocation details.
countryJSONOptional
country (anyOf 1)stringAlternativeISO 3166-1 alpha-2 country code of the location.
country (anyOf 2)nullAlternativeISO 3166-1 alpha-2 country code of the location.
idstringOptionalUnique identifier of the location.
Format: uuid
namestringOptionalName of the location.

List job openings — 200 response body — data item team Team details

FieldTypePresenceDescription and constraints
$objectRootTeam details.
idstringOptionalUnique identifier of the team.
Format: uuid
namestringOptionalName of the team.

List the active approval options for offers — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentActive approval options for offers
data[]ModelEach itemExpand List the active approval options for offers — 200 response body — data item
has_morebooleanRequired within parentAlways false: every option is returned at once
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeAlways null: every option is returned at once
next_cursor (anyOf 2)nullAlternativeAlways null: every option is returned at once
total_countJSONRequired within parent
total_count (anyOf 1)numberAlternativeNumber of options returned
Format: double
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List the active approval options for offers — 200 response body — data item

List the active approval options for offers — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription of the approval policy or approval rule
description (anyOf 2)nullAlternativeDescription of the approval policy or approval rule
idstringRequired within parentID of the approval policy or approval rule
Format: uuid
namestringRequired within parentName of the approval policy or approval rule
typestringRequired within parentWhether the item is an approval policy or an approval rule, which decides the offer field its id goes in
Known values: APPROVAL_POLICY, APPROVAL_RULE

List the offer letter templates of the organization — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentOffer letter templates that are not archived, most recently updated first
data[]ModelEach itemExpand List the offer letter templates of the organization — 200 response body — data item
has_morebooleanRequired within parentAlways false: every template is returned at once
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeAlways null: every template is returned at once
next_cursor (anyOf 2)nullAlternativeAlways null: every template is returned at once
total_countJSONRequired within parent
total_count (anyOf 1)numberAlternativeNumber of templates returned
Format: double
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List the offer letter templates of the organization — 200 response body — data item

List the offer letter templates of the organization — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription of the template
description (anyOf 2)nullAlternativeDescription of the template
idstringRequired within parentID of the offer letter template
Format: uuid
namestringRequired within parentName of the template
statusstringRequired within parentPUBLISHED templates are ready to use; DRAFT templates are still being edited
Known values: PUBLISHED, DRAFT
updated_atstringRequired within parentTimestamp when the template was last updated
Format: date-time

List the private note of a job — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentThe private note of the job, or an empty list when the job has none. A job has at most one note.
data[]ModelEach itemExpand List the private note of a job — 200 response body — data item
has_morebooleanRequired within parentAlways false: a job has at most one note.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeAlways null: a job has at most one note.
next_cursor (anyOf 2)nullAlternativeAlways null: a job has at most one note.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeNumber of notes on the job (0 or 1).
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List the private note of a job — 200 response body — data item

List the private note of a job — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentThe timestamp when the note was created
Format: date-time
created_by_hris_organization_user_idJSONRequired within parent
created_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user ID of the user who created the note
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user ID of the user who created the note
Format: uuid
idstringRequired within parentThe unique identifier of the job note
Format: uuid
richtext_contentstringRequired within parentThe content of the note in rich text HTML format
updated_atstringRequired within parentThe timestamp when the note was last changed
Format: date-time
updated_by_hris_organization_user_idJSONRequired within parent
updated_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user ID of the user who last changed the note
Format: uuid
updated_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user ID of the user who last changed the note
Format: uuid

Retrieve ATS Application form — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve ATS Application form — 200 response body — data

Referenced models: Retrieve ATS Application form — 200 response body — data

Retrieve ATS Application form — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
application_confirmation_email_template_idJSONRequired within parent
application_confirmation_email_template_id (anyOf 1)stringAlternativeUnique identifier for the application confirmation email template
Format: uuid
application_confirmation_email_template_id (anyOf 2)nullAlternativeUnique identifier for the application confirmation email template
Format: uuid
created_atstringRequired within parentTimestamp when the application form was created
Format: date-time
demographic_option_typesarrayOptionalArray of demographic option types for collecting diversity information
demographic_option_types[]ModelEach itemExpand Retrieve ATS Application form — 200 response body — data demographic option types item
demographic_section_helper_textJSONRequired within parent
demographic_section_helper_text (anyOf 1)stringAlternativeHelper text for the demographic section
demographic_section_helper_text (anyOf 2)nullAlternativeHelper text for the demographic section
demographic_section_titleJSONRequired within parent
demographic_section_title (anyOf 1)stringAlternativeTitle for the demographic section
demographic_section_title (anyOf 2)nullAlternativeTitle for the demographic section
form_builder_formJSONRequired within parentForm builder configuration
form_builder_form (anyOf 1)ModelAlternativeExpand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration
form_builder_form (anyOf 2)nullAlternative
form_builder_form_idJSONRequired within parent
form_builder_form_id (anyOf 1)stringAlternativeUnique identifier for the form builder form
Format: uuid
form_builder_form_id (anyOf 2)nullAlternativeUnique identifier for the form builder form
Format: uuid
form_builder_form_revision_idJSONRequired within parent
form_builder_form_revision_id (anyOf 1)stringAlternativeUnique identifier for the form builder form revision
Format: uuid
form_builder_form_revision_id (anyOf 2)nullAlternativeUnique identifier for the form builder form revision
Format: uuid
has_show_resume_fieldbooleanRequired within parentWhether to show the resume field
idstringRequired within parentUnique identifier for the application form
Format: uuid
is_linkedin_profile_url_requiredbooleanRequired within parentWhether the LinkedIn profile URL field is required
is_location_city_field_requiredbooleanRequired within parentWhether the city field is required, which is only required alongside the country field
is_location_country_field_requiredbooleanRequired within parentWhether the country field is required
is_phone_number_requiredbooleanRequired within parentWhether the phone number field is required
is_resume_requiredbooleanRequired within parentWhether the resume field is required
organization_idstringRequired within parentUnique identifier for the organization
Format: uuid
resume_field_helper_textJSONRequired within parent
resume_field_helper_text (anyOf 1)stringAlternativeHelper text for the resume field
resume_field_helper_text (anyOf 2)nullAlternativeHelper text for the resume field
richtext_descriptionJSONRequired within parent
richtext_description (anyOf 1)stringAlternativeRich text description of the application form
richtext_description (anyOf 2)nullAlternativeRich text description of the application form
sensitive_fields_idsJSONRequired within parent
sensitive_fields_ids (anyOf 1)arrayAlternativeArray of sensitive field IDs
sensitive_fields_ids (anyOf 1)[]stringEach itemFormat: uuid
sensitive_fields_ids (anyOf 2)nullAlternativeArray of sensitive field IDs
sensitive_fields_ids (anyOf 2)[]stringEach itemFormat: uuid
should_show_location_city_fieldbooleanRequired within parentWhether to show the city field, which is only shown alongside the country field
should_show_location_country_fieldbooleanRequired within parentWhether to show the country field
status_enumstringRequired within parentStatus of the application form
Known values: DRAFT, PUBLISHED, ARCHIVED
titlestringRequired within parentTitle of the application form
updated_atstringRequired within parentTimestamp when the application form was last updated
Format: date-time

Referenced models: Retrieve ATS Application form — 200 response body — data demographic option types item, Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration

Retrieve ATS Application form — 200 response body — data demographic option types item

FieldTypePresenceDescription and constraints
$objectRoot
helper_textJSONOptional
helper_text (anyOf 1)stringAlternativeHelper text for the option type
helper_text (anyOf 2)nullAlternativeHelper text for the option type
idstringOptionalUnique identifier for the demographic option type
Format: uuid
option_type_slugstringOptionalSlug for the option type
optionsarrayOptionalArray of available options for this demographic type
options[]ModelEach itemExpand Retrieve ATS Application form — 200 response body — data demographic option types item options item

Referenced models: Retrieve ATS Application form — 200 response body — data demographic option types item options item

Retrieve ATS Application form — 200 response body — data demographic option types item options item

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalUnique identifier for the option
Format: uuid
valuestringOptionalValue of the option

Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration

FieldTypePresenceDescription and constraints
$objectRootForm builder configuration
pagesarrayRequired within parentList of pages in the form
pages[]ModelEach itemExpand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item

Referenced models: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item

Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item

FieldTypePresenceDescription and constraints
$objectRootPages in the form
sectionsarrayRequired within parentSections within the page
sections[]ModelEach itemExpand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item
titlestringRequired within parentTitle of the form page

Referenced models: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item

Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item

FieldTypePresenceDescription and constraints
$objectRootSections within the page
questionsarrayRequired within parentList of questions within the section
questions[]ModelEach itemExpand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item
subtitlestringOptionalAdditional information shown at the top of the section
titlestringRequired within parentTitle of the section

Referenced models: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item

Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item

FieldTypePresenceDescription and constraints
$objectRootList of questions within the section
date_limitationJSONOptional
date_limitation (anyOf 1)stringAlternativeLimits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now
date_limitation (anyOf 2)nullAlternativeLimits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now
default_valueJSONOptional
default_value (anyOf 1)stringAlternativeDefault value to pre-fill in the form
default_value (anyOf 2)nullAlternativeDefault value to pre-fill in the form
has_request_validationbooleanOptionalWhether additional validation should be triggered for this field
helper_textJSONOptional
helper_text (anyOf 1)stringAlternativeAdditional information to assist the user
helper_text (anyOf 2)nullAlternativeAdditional information to assist the user
is_disabledbooleanOptionalIf true, the field is disabled and cannot be edited
is_multiple_selectionbooleanOptionalIndicates if the user can select multiple values
is_only_digitsbooleanOptionalRestricts input to numeric characters only, for FreeText questions
is_rangebooleanOptionalSpecifies whether a date picker allows range selection
is_requiredbooleanOptionalIndicates if the question is required
keystringOptionalUnique key identifier for the question
max_lengthJSONOptional
max_length (anyOf 1)JSONAlternative
max_length (anyOf 1) (anyOf 1)integerAlternativeMaximum character length for text responses
max_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_length (anyOf 2)nullAlternativeMaximum character length for text responses
max_valueJSONOptional
max_value (anyOf 1)JSONAlternative
max_value (anyOf 1) (anyOf 1)numberAlternativeMaximum value allowed
Format: double
max_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_value (anyOf 2)nullAlternativeMaximum value allowed
Format: double
min_lengthJSONOptional
min_length (anyOf 1)JSONAlternative
min_length (anyOf 1) (anyOf 1)integerAlternativeMinimum character length for text responses
min_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_length (anyOf 2)nullAlternativeMinimum character length for text responses
min_valueJSONOptional
min_value (anyOf 1)JSONAlternative
min_value (anyOf 1) (anyOf 1)numberAlternativeMinimum value allowed
Format: double
min_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_value (anyOf 2)nullAlternativeMinimum value allowed
Format: double
number_typestringOptionalUsed for number fields to define the unit or representation
optionsJSONOptional
options (anyOf 1)arrayAlternativeList of selectable options for selection-type questions
options (anyOf 1)[]ModelEach itemExpand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item options null item
options (anyOf 2)nullAlternativeList of selectable options for selection-type questions
options (anyOf 2)[]ModelEach itemExpand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item options null item
rulesJSONOptional
rules (anyOf 1)arrayAlternativeValidation rules for the question
rules (anyOf 1)[]ModelEach itemExpand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item rules Validation rules for the question item
rules (anyOf 2)nullAlternativeValidation rules for the question
rules (anyOf 2)[]ModelEach itemExpand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item rules Validation rules for the question item
sourceJSONOptionalDefines dynamic data source for the question
source (anyOf 1)ModelAlternativeExpand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item source Defines dynamic data source for the question
source (anyOf 2)nullAlternative
titlestringRequired within parentTitle of the question
typestringRequired within parentType of the question
Known values: FREETEXT, PARAGRAPH, SINGLESELECTION, MULTISELECTION, ADDRESS, PHONENUMBER, DOCUMENTUPLOAD, NUMBER, DROPDOWN, DATEPICKER, EMAIL, CUSTOMDROPDOWN, PRESETDROPDOWN, NESTED

Referenced models: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item source Defines dynamic data source for the question, Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item options null item, Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item rules Validation rules for the question item

Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item options null item

FieldTypePresenceDescription and constraints
$objectRoot
titlestringRequired within parentDisplay text for the option
valueJSONOptional
value (anyOf 1)stringAlternativeValue associated with the option
value (anyOf 2)nullAlternativeValue associated with the option

Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item rules Validation rules for the question item

FieldTypePresenceDescription and constraints
$objectRootValidation rules for the question
date_limitationJSONOptional
date_limitation (anyOf 1)stringAlternativeLimits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now
date_limitation (anyOf 2)nullAlternativeLimits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now
default_valueJSONOptional
default_value (anyOf 1)stringAlternativeDefault value to pre-fill in the form
default_value (anyOf 2)nullAlternativeDefault value to pre-fill in the form
has_request_validationbooleanOptionalWhether additional validation should be triggered for this field
helper_textJSONOptional
helper_text (anyOf 1)stringAlternativeAdditional information to assist the user
helper_text (anyOf 2)nullAlternativeAdditional information to assist the user
is_disabledbooleanOptionalIf true, the field is disabled and cannot be edited
is_multiple_selectionbooleanOptionalIndicates if the user can select multiple values
is_only_digitsbooleanOptionalRestricts input to numeric characters only, for FreeText questions
is_rangebooleanOptionalSpecifies whether a date picker allows range selection
is_requiredbooleanOptionalIndicates if the question is required
max_lengthJSONOptional
max_length (anyOf 1)JSONAlternative
max_length (anyOf 1) (anyOf 1)integerAlternativeMaximum character length for text responses
max_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_length (anyOf 2)nullAlternativeMaximum character length for text responses
max_valueJSONOptional
max_value (anyOf 1)JSONAlternative
max_value (anyOf 1) (anyOf 1)numberAlternativeMaximum value allowed
Format: double
max_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_value (anyOf 2)nullAlternativeMaximum value allowed
Format: double
min_lengthJSONOptional
min_length (anyOf 1)JSONAlternative
min_length (anyOf 1) (anyOf 1)integerAlternativeMinimum character length for text responses
min_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_length (anyOf 2)nullAlternativeMinimum character length for text responses
min_valueJSONOptional
min_value (anyOf 1)JSONAlternative
min_value (anyOf 1) (anyOf 1)numberAlternativeMinimum value allowed
Format: double
min_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_value (anyOf 2)nullAlternativeMinimum value allowed
Format: double
number_typestringOptionalUsed for number fields to define the unit or representation
optionsJSONOptional
options (anyOf 1)arrayAlternativeList of selectable options for selection-type questions. Value may be of any type.
options (anyOf 1)[]JSONEach itemAny type
options (anyOf 2)nullAlternativeList of selectable options for selection-type questions. Value may be of any type.
options (anyOf 2)[]JSONEach itemAny type
requiresarrayOptionalList of conditions that must be met for this rule to apply
requires[]JSONEach itemAny type
sourceJSONOptionalDefines dynamic data source for the question
source (anyOf 1)ModelAlternativeExpand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item source Defines dynamic data source for the question
source (anyOf 2)nullAlternative
titlestringOptionalTitle of the question

Referenced models: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item source Defines dynamic data source for the question

Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item source Defines dynamic data source for the question

FieldTypePresenceDescription and constraints
$objectRootDefines dynamic data source for the question
definitionstringOptionalReference URL for API documentation
descriptionstringOptionalDescription of the data source
urlstringOptionalAPI endpoint providing dynamic options

Retrieve ATS email template tokens — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPlaceholder tokens available in email templates.
data[]ModelEach itemExpand Retrieve ATS email template tokens — 200 response body — data item
has_morebooleanRequired within parentAlways false: the catalogue is returned in full.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeAlways null: the catalogue is returned in full.
next_cursor (anyOf 2)nullAlternativeAlways null: the catalogue is returned in full.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeNumber of tokens in data.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve ATS email template tokens — 200 response body — data item

Retrieve ATS email template tokens — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
categorystringRequired within parentWhat the token resolves from
Known values: CANDIDATE, SENDER, ORGANIZATION, OFFER, INTERVIEW, QUESTIONNAIRE, APPLICATION_FORM, REFERRER, DOCUMENT
codestringRequired within parentPlaceholder as written in a template subject or body
idstringRequired within parentUnique identifier of the token
Format: uuid
labelstringRequired within parentHuman-readable name of the token

Retrieve ATS job — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve ATS job — 200 response body — data

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

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.