Skip to content

Deel: ATS schemas (part 2)

80 Deel schemas with complete fields and constraints.

← ATS operations · All schemas

Retrieve ATS job — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
active_pause_periodJSONOptionalThe pause currently in effect. Set only when status is PAUSED; null otherwise.
active_pause_period (anyOf 1)ModelAlternativeExpand Retrieve ATS job — 200 response body — data active pause period id, paused at
active_pause_period (anyOf 2)nullAlternative
applications_countJSONOptional
applications_count (anyOf 1)JSONAlternative
applications_count (anyOf 1) (anyOf 1)integerAlternativeNumber of applications for the job
applications_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
applications_count (anyOf 2)nullAlternativeNumber of applications for the job
approval_requestJSONRequired within parentApproval request for the job. Null when the job never went through approval.
approval_request (anyOf 1)ModelAlternativeExpand Retrieve ATS job — 200 response body — data approval request id, requested at, status, updated at
approval_request (anyOf 2)nullAlternative
approval_request_idJSONOptional
approval_request_id (anyOf 1)stringAlternativeUnique identifier for the approval request
Format: uuid
approval_request_id (anyOf 2)nullAlternativeUnique identifier for the approval request
Format: uuid
approval_rule_idJSONOptional
approval_rule_id (anyOf 1)stringAlternativeUnique identifier for the approval rule
Format: uuid
approval_rule_id (anyOf 2)nullAlternativeUnique identifier for the approval rule
Format: uuid
closed_atJSONOptional
closed_at (anyOf 1)stringAlternativeWhen the job was closed. Null when it is not closed.
Format: date-time
closed_at (anyOf 2)nullAlternativeWhen the job was closed. Null when it is not closed.
Format: date-time
closure_reasonJSONRequired within parentWhy the job was closed. Null when the job is not closed or no reason was recorded.
closure_reason (anyOf 1)ModelAlternativeExpand Retrieve ATS job — 200 response body — data closure reason id, name
closure_reason (anyOf 2)nullAlternative
created_atstringOptionalTimestamp when the job was created
Format: date-time
created_by_hris_organization_user_idJSONOptional
created_by_hris_organization_user_id (anyOf 1)stringAlternativeUnique identifier of the user who created the job
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeUnique identifier of the user who created the job
Format: uuid
current_compensationJSONOptional
current_compensation (anyOf 1)ModelAlternativeExpand Retrieve ATS job — 200 response body — data / current_compensation / period_slug: ANNUALLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY
current_compensation (anyOf 2)nullAlternative
hiring_member_job_permissions_by_type_slugJSONOptional
hiring_member_job_permissions_by_type_slug (anyOf 1)ModelAlternativeExpand Retrieve ATS job — 200 response body — data hiring member job permissions by type slug application form submission, application form submission sensitive fields, compensation, hiring team, interview plan, job posting
hiring_member_job_permissions_by_type_slug (anyOf 2)nullAlternative
hiring_membersJSONOptional
hiring_members (anyOf 1)arrayAlternativeHiring members associated with the job
hiring_members (anyOf 1)[]ModelEach itemExpand Retrieve ATS job — 200 response body — data hiring members Hiring members associated with the job item
hiring_members (anyOf 2)nullAlternativeHiring members associated with the job
hiring_members (anyOf 2)[]ModelEach itemExpand Retrieve ATS job — 200 response body — data hiring members Hiring members associated with the job item
idstringRequired within parentUnique identifier for the job
Format: uuid
interview_plan_stagesarrayRequired within parentInterview plan stages that currently hold at least one application, ordered by position.
interview_plan_stages[]ModelEach itemExpand Retrieve ATS job — 200 response body — data interview plan stages item
is_confidentialbooleanOptionalIndicates if the job is confidential
job_departmentsJSONOptional
job_departments (anyOf 1)arrayAlternativeDepartments associated with the job
job_departments (anyOf 1)[]ModelEach itemExpand Create ATS Job — 201 response body — data job departments Departments associated with the job item
job_departments (anyOf 2)nullAlternativeDepartments associated with the job
job_departments (anyOf 2)[]ModelEach itemExpand Create ATS Job — 201 response body — data job departments Departments associated with the job item
job_employment_typesarrayOptionalEmployment types associated with the job
job_employment_types[]ModelEach itemExpand Create ATS Job — 201 response body — data job employment types item
job_locationsarrayOptionalLocations associated with the job
job_locations[]ModelEach itemExpand Create ATS Job — 201 response body — data job locations item
job_teamsJSONOptional
job_teams (anyOf 1)arrayAlternativeTeams associated with the job
job_teams (anyOf 1)[]ModelEach itemExpand Create ATS Job — 201 response body — data job teams item
job_teams (anyOf 2)nullAlternativeTeams associated with the job
job_teams (anyOf 2)[]ModelEach itemExpand Create ATS Job — 201 response body — data job teams item
opened_atJSONOptional
opened_at (anyOf 1)stringAlternativeWhen the job was first opened. Not reset when the job is reopened or resumed. Null when it was never opened.
Format: date-time
opened_at (anyOf 2)nullAlternativeWhen the job was first opened. Not reset when the job is reopened or resumed. Null when it was never opened.
Format: date-time
richtext_descriptionJSONOptional
richtext_description (anyOf 1)stringAlternativeRich text description of the job
richtext_description (anyOf 2)nullAlternativeRich text description of the job
statusstringRequired within parentJob status. PAUSED jobs are open but temporarily not accepting candidates; see active_pause_period.
Known values: OPEN, PAUSED, CLOSED, DRAFT, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, ARCHIVED
titlestringRequired within parentJob title
updated_atstringOptionalTimestamp when the job was last updated
Format: date-time
work_arrangement_enumJSONOptionalWork arrangement of the job. Null when unspecified.
work_arrangement_enum (anyOf 1)stringAlternativeWork arrangement of the job. Null when unspecified.
Known values: ON_SITE, HYBRID, REMOTE
work_arrangement_enum (anyOf 2)nullAlternative

Referenced models: Retrieve ATS job — 200 response body — data active pause period id, paused at, Retrieve ATS job — 200 response body — data hiring member job permissions by type slug application form submission, application form submission sensitive fields, compensation, hiring team, interview plan, job posting, Retrieve ATS job — 200 response body — data hiring members Hiring members associated with the job item, Create ATS Job — 201 response body — data job employment types item, Create ATS Job — 201 response body — data job locations item, Create ATS Job — 201 response body — data job teams item, Retrieve ATS job — 200 response body — data closure reason id, name, Retrieve ATS job — 200 response body — data / current_compensation / period_slug: ANNUALLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY, Create ATS Job — 201 response body — data job departments Departments associated with the job item, Retrieve ATS job — 200 response body — data approval request id, requested at, status, updated at, Retrieve ATS job — 200 response body — data interview plan stages item

Retrieve ATS job — 200 response body — data / current_compensation / period_slug: ANNUALLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY

FieldTypePresenceDescription and constraints
$objectRoot
currency_iso_codestringOptionalISO code of the currency
idstringOptionalUnique identifier for the compensation
Format: uuid
job_idstringOptionalJob ID associated with the compensation
Format: uuid
max_amountJSONOptional
max_amount (anyOf 1)JSONAlternative
max_amount (anyOf 1) (anyOf 1)numberAlternativeMaximum compensation amount
Format: double
max_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_amount (anyOf 2)nullAlternativeMaximum compensation amount
Format: double
min_amountJSONOptional
min_amount (anyOf 1)JSONAlternative
min_amount (anyOf 1) (anyOf 1)numberAlternativeMinimum compensation amount
Format: double
min_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_amount (anyOf 2)nullAlternativeMinimum compensation amount
Format: double
period_slugstringOptionalCompensation period
Known values: ANNUALLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY

Retrieve ATS job — 200 response body — data active pause period id, paused at

FieldTypePresenceDescription and constraints
$objectRootThe pause currently in effect. Set only when status is PAUSED; null otherwise.
idstringRequired within parentUnique identifier of the pause period
Format: uuid
paused_atstringRequired within parentWhen the job was paused
Format: date-time

Retrieve ATS job — 200 response body — data approval request id, requested at, status, updated at

FieldTypePresenceDescription and constraints
$objectRootApproval request for the job. Null when the job never went through approval.
idstringRequired within parentUnique identifier of the approval request.
requested_atstringRequired within parentWhen approval was requested.
Format: date-time
statusstringRequired within parentCurrent state of the approval request. PENDING and PARTIALLY_APPROVED mean approvers still have to act.
Known values: PENDING, QUEUED, PARTIALLY_APPROVED, APPROVED, REJECTED, CANCELED, SKIPPED
updated_atstringRequired within parentWhen the approval request last changed.
Format: date-time

Retrieve ATS job — 200 response body — data closure reason id, name

FieldTypePresenceDescription and constraints
$objectRootWhy the job was closed. Null when the job is not closed or no reason was recorded.
idstringRequired within parentUnique identifier of the closure reason
Format: uuid
namestringRequired within parentClosure reason label

Retrieve ATS job — 200 response body — data hiring member job permissions by type slug application form submission, application form submission sensitive fields, compensation, hiring team, interview plan, job posting

FieldTypePresenceDescription and constraints
$objectRoot
application_form_submissionstringOptionalApplication form submission permissions
application_form_submission_sensitive_fieldsstringOptionalApplication form submission sensitive fields permissions
compensationstringOptionalCompensation permissions
hiring_teamstringOptionalHiring team permissions
interview_planstringOptionalInterview plan permissions
job_postingstringOptionalJob posting permissions

Retrieve ATS job — 200 response body — data hiring members Hiring members associated with the job item

FieldTypePresenceDescription and constraints
$objectRoot
hris_organization_user_idstringOptionalUnique identifier for the HRIS organization user
Format: uuid
idstringOptionalUnique identifier for the hiring member
Format: uuid

Retrieve ATS job — 200 response body — data interview plan stages item

FieldTypePresenceDescription and constraints
$objectRoot
candidates_countJSONOptional
candidates_count (anyOf 1)integerAlternativeNumber of applications currently in this stage
candidates_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
category_type_slugstringOptionalCategory type of the interview plan stage
Known values: LEAD, ACTIVE, COMPLETED
default_type_slugJSONOptional
default_type_slug (anyOf 1)stringAlternativeDefault type slug of the interview plan stage
default_type_slug (anyOf 2)nullAlternativeDefault type slug of the interview plan stage
idstringOptionalUnique identifier for the interview plan stage
Format: uuid
interview_plan_idJSONOptional
interview_plan_id (anyOf 1)stringAlternativeInterview plan ID associated with this stage
Format: uuid
interview_plan_id (anyOf 2)nullAlternativeInterview plan ID associated with this stage
Format: uuid
namestringOptionalCustomer-defined stage name
position_numberJSONOptional
position_number (anyOf 1)JSONAlternative
position_number (anyOf 1) (anyOf 1)integerAlternativePosition number of the stage in the interview plan
position_number (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
position_number (anyOf 2)nullAlternativePosition number of the stage in the interview plan

Retrieve ATS offer — 200 response body

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

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

Retrieve ATS offer — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
additional_detailsJSONOptional
additional_details (anyOf 1)stringAlternativeAdditional details about the offer
additional_details (anyOf 2)nullAlternativeAdditional details about the offer
applicationModelRequired within parentExpand Retrieve ATS offer — 200 response body — data application
The application this offer was made on, so an offer identifies its own candidate and job without a second lookup. Always present: an offer whose application the caller cannot see is not returned at all.
application_interview_plan_stage_idstringOptionalApplication interview plan stage identifier
Format: uuid
approval_requestJSONRequired within parentApproval request for the offer. Null when the offer never went through approval.
approval_request (anyOf 1)ModelAlternativeExpand Retrieve ATS offer — 200 response body — data approval request id, requested at, status, updated at
approval_request (anyOf 2)nullAlternative
approval_request_idJSONOptional
approval_request_id (anyOf 1)stringAlternativeApproval request identifier
Format: uuid
approval_request_id (anyOf 2)nullAlternativeApproval request identifier
Format: uuid
approval_rule_idJSONOptional
approval_rule_id (anyOf 1)stringAlternativeApproval rule identifier
Format: uuid
approval_rule_id (anyOf 2)nullAlternativeApproval rule identifier
Format: uuid
attachment_idJSONOptional
attachment_id (anyOf 1)stringAlternativeAttachment identifier
Format: uuid
attachment_id (anyOf 2)nullAlternativeAttachment identifier
Format: uuid
compensation_amountJSONOptional
compensation_amount (anyOf 1)numberAlternativeCompensation amount
Format: double
compensation_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
compensation_currencystringOptionalCompensation currency
compensation_period_slugstringOptionalCompensation period
Known values: annually, monthly, semimonthly, biweekly, weekly, daily, hourly
country_codestringOptionalCountry code
Format: country-code
created_atstringOptionalTimestamp when the offer was created
Format: date-time
custom_fieldsarrayOptionalCustom fields attached to the offer
custom_fields[]ModelEach itemExpand Retrieve ATS offer — 200 response body — data custom fields item
emailJSONOptionalEmail the offer was sent with. Null when the offer was never emailed.
email (anyOf 1)ModelAlternativeExpand Retrieve ATS offer — 200 response body — data email body html, from string, id, recipients bcc, recipients cc, recipients to, subject
email (anyOf 2)nullAlternative
expires_atJSONOptional
expires_at (anyOf 1)stringAlternativeDate when the sent offer expires if the candidate has not responded
Format: date
expires_at (anyOf 2)nullAlternativeDate when the sent offer expires if the candidate has not responded
Format: date
idstringRequired within parentUnique identifier
Format: uuid
job_titlestringOptionalJob title
offer_letter_template_idJSONOptional
offer_letter_template_id (anyOf 1)stringAlternativeOffer letter template identifier
Format: uuid
offer_letter_template_id (anyOf 2)nullAlternativeOffer letter template identifier
Format: uuid
offer_statusstringRequired within parentOffer status
Known values: CREATED, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, SENT, EXPIRED, ACCEPTED, REJECTED
rejection_reason_idJSONOptional
rejection_reason_id (anyOf 1)stringAlternativeRejection reason identifier
Format: uuid
rejection_reason_id (anyOf 2)nullAlternativeRejection reason identifier
Format: uuid
replied_atJSONOptional
replied_at (anyOf 1)stringAlternativeTimestamp when the candidate replied (accepted or rejected) to the offer
Format: date-time
replied_at (anyOf 2)nullAlternativeTimestamp when the candidate replied (accepted or rejected) to the offer
Format: date-time
sent_atJSONOptional
sent_at (anyOf 1)stringAlternativeTimestamp when the offer reached the candidate, through Deel or another channel; null until it has been sent
Format: date-time
sent_at (anyOf 2)nullAlternativeTimestamp when the offer reached the candidate, through Deel or another channel; null until it has been sent
Format: date-time
start_datestringOptionalStart date
Format: date-time
updated_atstringOptionalTimestamp when the offer was last updated
Format: date-time
worker_typestringOptionalWorker type
Known values: CONTRACTOR_FIXED, CONTRACTOR_PAY_AS_YOU_GO, CONTRACTOR_MILESTONE, DIRECT_EMPLOYEE, EOR_EMPLOYEE, GLOBAL_PAYROLL_EMPLOYEE, PEO_EMPLOYEE, PWAC, UNKNOWN

Referenced models: Retrieve ATS offer — 200 response body — data application, Retrieve ATS offer — 200 response body — data approval request id, requested at, status, updated at, Retrieve ATS offer — 200 response body — data custom fields item, Retrieve ATS offer — 200 response body — data email body html, from string, id, recipients bcc, recipients cc, recipients to, subject

Retrieve ATS offer — 200 response body — data application

FieldTypePresenceDescription and constraints
$objectRootThe application this offer was made on, so an offer identifies its own candidate and job without a second lookup. Always present: an offer whose application the caller cannot see is not returned at all.
candidateJSONRequired within parentThe candidate who received the offer. Null once the candidate has been deleted or anonymized.
candidate (anyOf 1)ModelAlternativeExpand Retrieve ATS offer — 200 response body — data application candidate first name, id, last name
candidate (anyOf 2)nullAlternative
idstringRequired within parentApplication unique identifier
Format: uuid
jobModelRequired within parentExpand Retrieve ATS offer — 200 response body — data application job
The job the application belongs to. The title repeats the offer's own job_title field.

Referenced models: Retrieve ATS offer — 200 response body — data application candidate first name, id, last name, Retrieve ATS offer — 200 response body — data application job

Retrieve ATS offer — 200 response body — data application candidate first name, id, last name

FieldTypePresenceDescription and constraints
$objectRootThe candidate who received the offer. Null once the candidate has been deleted or anonymized.
first_namestringRequired within parentCandidate first name
idstringRequired within parentCandidate unique identifier
Format: uuid
last_namestringRequired within parentCandidate last name

Retrieve ATS offer — 200 response body — data application job

FieldTypePresenceDescription and constraints
$objectRootThe job the application belongs to. The title repeats the offer's own job_title field.
idstringRequired within parentJob unique identifier
Format: uuid
titlestringRequired within parentJob title

Retrieve ATS offer — 200 response body — data approval request id, requested at, status, updated at

FieldTypePresenceDescription and constraints
$objectRootApproval request for the offer. Null when the offer never went through approval.
idstringRequired within parentUnique identifier of the approval request.
requested_atstringRequired within parentWhen approval was requested.
Format: date-time
statusstringRequired within parentCurrent state of the approval request. PENDING and PARTIALLY_APPROVED mean approvers still have to act.
Known values: PENDING, QUEUED, PARTIALLY_APPROVED, APPROVED, REJECTED, CANCELED, SKIPPED
updated_atstringRequired within parentWhen the approval request last changed.
Format: date-time

Retrieve ATS offer — 200 response body — data custom fields item

FieldTypePresenceDescription and constraints
$objectRootCustom field attached to the offer
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the custom field
description (anyOf 2)nullAlternativeDescription of the custom field
idstringRequired within parentUnique identifier for the custom field
Format: uuid
is_requiredbooleanRequired within parentWhether the custom field is required
namestringRequired within parentCustom field name
typestringRequired within parentType of custom field
Known values: TEXT, PERCENTAGE, LIST, MULTISELECT, DATE, NUMBER, CURRENCY, HYPERLINK

Retrieve ATS offer — 200 response body — data email body html, from string, id, recipients bcc, recipients cc, recipients to, subject

FieldTypePresenceDescription and constraints
$objectRootEmail the offer was sent with. Null when the offer was never emailed.
body_htmlJSONOptional
body_html (anyOf 1)stringAlternativeEmail body as HTML
body_html (anyOf 2)nullAlternativeEmail body as HTML
from_stringstringRequired within parentSender, as shown in the From header
idstringRequired within parentUnique identifier of the email
recipients_bccJSONOptional
recipients_bcc (anyOf 1)arrayAlternativeBlind-carbon-copy recipients
recipients_bcc (anyOf 1)[]stringEach item
recipients_bcc (anyOf 2)nullAlternativeBlind-carbon-copy recipients
recipients_bcc (anyOf 2)[]stringEach item
recipients_ccJSONOptional
recipients_cc (anyOf 1)arrayAlternativeCarbon-copy recipients
recipients_cc (anyOf 1)[]stringEach item
recipients_cc (anyOf 2)nullAlternativeCarbon-copy recipients
recipients_cc (anyOf 2)[]stringEach item
recipients_toarrayRequired within parentPrimary recipients
recipients_to[]stringEach item
subjectstringRequired within parentEmail subject

Retrieve a list of ATS hires — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of application-to-HRIS-profile records, ordered by updated_at ascending.
data[]ModelEach itemExpand Retrieve a list of ATS hires — 200 response body — data item
has_morebooleanRequired within parentWhether more pages are available beyond the current one.
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 hires matching the filters.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

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

FieldTypePresenceDescription and constraints
$objectRoot
application_idstringRequired within parentIdentifier of the ATS application that was moved to HRIS
Format: uuid
candidate_idstringRequired within parentIdentifier of the candidate the application belongs to
Format: uuid
draft_quote_idJSONRequired within parent
draft_quote_id (anyOf 1)stringAlternativeIdentifier of the draft quote associated with this hire. Null when no draft quote exists.
Format: uuid
draft_quote_id (anyOf 2)nullAlternativeIdentifier of the draft quote associated with this hire. Null when no draft quote exists.
Format: uuid
hris_profile_idJSONRequired within parent
hris_profile_id (anyOf 1)JSONAlternative
hris_profile_id (anyOf 1) (anyOf 1)integerAlternativeNumeric identifier of the HRIS profile the application was hired into. Null while the profile does not exist yet.
hris_profile_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hris_profile_id (anyOf 2)nullAlternativeNumeric identifier of the HRIS profile the application was hired into. Null while the profile does not exist yet.
hris_profile_public_idJSONRequired within parent
hris_profile_public_id (anyOf 1)stringAlternativePublic (UUID) identifier of the same HRIS profile as hris_profile_id. Null while the profile does not exist yet.
Format: uuid
hris_profile_public_id (anyOf 2)nullAlternativePublic (UUID) identifier of the same HRIS profile as hris_profile_id. Null while the profile does not exist yet.
Format: uuid
offer_idstringRequired within parentIdentifier of the accepted offer the hire was created from
Format: uuid
organization_idstringRequired within parentIdentifier of the organization that owns the record
Format: uuid
status_enumstringRequired within parentState of the move to HRIS. DRAFT: a draft quote exists but no contract yet. CREATED: the HRIS profile and contract exist. DRAFT_DELETED: the draft was discarded.
Known values: DRAFT, DRAFT_DELETED, CREATED
updated_atstringRequired within parentTimestamp of the last change to the record. Records are returned oldest change first, so the last row of a drain is a safe watermark.
Format: date-time
worker_idJSONRequired within parent
worker_id (anyOf 1)JSONAlternative
worker_id (anyOf 1) (anyOf 1)integerAlternativeWorker identifier of the same HRIS profile. Null while the profile does not exist yet.
worker_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
worker_id (anyOf 2)nullAlternativeWorker identifier of the same HRIS profile. Null while the profile does not exist yet.

Retrieve a list of ATS job boards — 200 response body

FieldTypePresenceDescription and constraints
$objectRootPaginated list of job boards with cursor-based pagination
dataarrayRequired within parentPage of job boards
data[]ModelEach itemExpand Retrieve a list of ATS job boards — 200 response body — data item
has_morebooleanRequired within parentIndicates if there are more job boards to fetch
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page of results
next_cursor (anyOf 2)nullAlternativeCursor for the next page of results
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of job boards available
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

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

FieldTypePresenceDescription and constraints
$objectRootJob board with type, status, settings, and associated career page configuration if applicable
career_page_settingJSONOptionalCareer page settings associated with the job board
career_page_setting (anyOf 1)ModelAlternativeExpand Retrieve a list of ATS job boards — 200 response body — data item career page setting Career page settings associated with the job board
career_page_setting (anyOf 2)nullAlternative
created_atstringRequired within parentTimestamp when the job board was created
Format: date-time
idstringRequired within parentJob board unique identifier
Format: uuid
settings_jsonJSONRequired within parentJob board specific settings
settings_json (anyOf 1)ModelAlternativeExpand Retrieve a list of ATS job boards — 200 response body — data item settings json Job board specific settings
settings_json (anyOf 2)nullAlternative
status_enumstringRequired within parentCurrent status of the job board
Known values: ENABLED, DISABLED, ARCHIVED
type_enumstringRequired within parentType of the job board
Known values: INTERNAL_CAREER_PAGE, EXTERNAL_CAREER_PAGE, LINKEDIN
updated_atstringRequired within parentTimestamp when the job board was last updated
Format: date-time

Referenced models: Retrieve a list of ATS job boards — 200 response body — data item settings json Job board specific settings, Retrieve a list of ATS job boards — 200 response body — data item career page setting Career page settings associated with the job board

Retrieve a list of ATS job boards — 200 response body — data item career page setting Career page settings associated with the job board

FieldTypePresenceDescription and constraints
$objectRootCareer page settings associated with the job board
banner_image_urlJSONRequired within parent
banner_image_url (anyOf 1)stringAlternativeURL for the banner image
banner_image_url (anyOf 2)nullAlternativeURL for the banner image
dark_mode_color_primary_hexcodeJSONRequired within parent
dark_mode_color_primary_hexcode (anyOf 1)stringAlternativePrimary color hex code for dark mode
dark_mode_color_primary_hexcode (anyOf 2)nullAlternativePrimary color hex code for dark mode
dark_mode_logo_urlJSONRequired within parent
dark_mode_logo_url (anyOf 1)stringAlternativeURL for the logo in dark mode
dark_mode_logo_url (anyOf 2)nullAlternativeURL for the logo in dark mode
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription displayed on the career page
description (anyOf 2)nullAlternativeDescription displayed on the career page
idstringRequired within parentCareer page setting unique identifier
Format: uuid
is_primarybooleanRequired within parentWhether this is the primary career page setting
light_mode_color_primary_hexcodeJSONRequired within parent
light_mode_color_primary_hexcode (anyOf 1)stringAlternativePrimary color hex code for light mode
light_mode_color_primary_hexcode (anyOf 2)nullAlternativePrimary color hex code for light mode
light_mode_logo_urlJSONRequired within parent
light_mode_logo_url (anyOf 1)stringAlternativeURL for the logo in light mode
light_mode_logo_url (anyOf 2)nullAlternativeURL for the logo in light mode
organization_idstringRequired within parentOrganization unique identifier
Format: uuid
preferred_organization_namestringRequired within parentDisplay name for the organization on the career page
should_show_banner_on_job_details_pagebooleanRequired within parentWhether to show the banner on job details page
should_show_job_filtersbooleanRequired within parentWhether to show job filtering options
should_show_logobooleanRequired within parentWhether to show the organization logo
titleJSONRequired within parent
title (anyOf 1)stringAlternativeTitle displayed on the career page
title (anyOf 2)nullAlternativeTitle displayed on the career page
url_slugstringRequired within parentURL slug for the career page

Retrieve a list of ATS job boards — 200 response body — data item settings json Job board specific settings

FieldTypePresenceDescription and constraints
$objectRootJob board specific settings
company_idstringOptionalCompany ID for external job boards (e.g., LinkedIn)

Retrieve a list of ATS teams — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of resources.
data[]ModelEach itemExpand Retrieve a list of ATS teams — 200 response body — data item
has_morebooleanRequired within parentIndicates if there are more teams available
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for pagination to get the next set of results
next_cursor (anyOf 2)nullAlternativeCursor for pagination to get the next set of results
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of teams available
Minimum: 0
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

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

FieldTypePresenceDescription and constraints
$objectRoot
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeTimestamp when the team was archived; null while the team is active and selectable
Format: date-time
archived_at (anyOf 2)nullAlternativeTimestamp when the team was archived; null while the team is active and selectable
Format: date-time
created_atstringRequired within parentTimestamp when the team was created
Format: date-time
department_teamsarrayRequired within parentArray of department-team relationships
department_teams[]ModelEach itemExpand Retrieve a list of ATS teams — 200 response body — data item department teams item
idstringRequired within parentUnique identifier for the team
Format: uuid
namestringRequired within parentName of the team
organization_idstringRequired within parentUnique identifier for the organization
Format: uuid
richtext_descriptionstringOptionalRich text description of the team
updated_atstringRequired within parentTimestamp when the team was last updated
Format: date-time

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

Retrieve a list of ATS teams — 200 response body — data item department teams item

FieldTypePresenceDescription and constraints
$objectRoot
departmentModelRequired within parentExpand Retrieve a list of ATS teams — 200 response body — data item department teams item department
idstringRequired within parentUnique identifier for the department-team relationship
Format: uuid

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

Retrieve a list of ATS teams — 200 response body — data item department teams item department

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the department
Format: uuid
namestringRequired within parentName of the department

Retrieve an ATS candidate — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve an ATS candidate — 200 response body — data
Candidate detail.

Referenced models: Retrieve an ATS candidate — 200 response body — data

Retrieve an ATS candidate — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootCandidate detail.
anonymized_atJSONOptional
anonymized_at (anyOf 1)stringAlternativeWhen the candidate data was anonymized.
Format: date-time
anonymized_at (anyOf 2)nullAlternativeWhen the candidate data was anonymized.
Format: date-time
applicationsarrayRequired within parentApplications of the candidate the authenticated user may see, newest first.
applications[]ModelEach itemExpand Retrieve an ATS candidate — 200 response body — data applications item
attachmentsarrayRequired within parentDocuments attached to the candidate, newest first.
attachments[]ModelEach itemExpand Retrieve an ATS candidate — 200 response body — data attachments item
candidate_tagsarrayRequired within parentTags applied to the candidate.
candidate_tags[]ModelEach itemExpand Retrieve an ATS candidate — 200 response body — data candidate tags item
cityJSONOptional
city (anyOf 1)stringAlternativeCity the candidate currently lives in
city (anyOf 2)nullAlternativeCity the candidate currently lives in
country_codeJSONOptional
country_code (anyOf 1)stringAlternativeISO 3166-1 alpha-2 country the candidate currently lives in
country_code (anyOf 2)nullAlternativeISO 3166-1 alpha-2 country the candidate currently lives in
created_atstringRequired within parentWhen the candidate was created.
Format: date-time
emailstringRequired within parentCandidate's email address.
Format: email
final_archivation_atJSONOptional
final_archivation_at (anyOf 1)stringAlternativeWhen the candidate was finally archived.
Format: date-time
final_archivation_at (anyOf 2)nullAlternativeWhen the candidate was finally archived.
Format: date-time
first_namestringRequired within parentCandidate's first name.
idstringRequired within parentCandidate identifier.
Format: uuid
import_session_idJSONOptional
import_session_id (anyOf 1)stringAlternativeBulk import session the candidate came from.
import_session_id (anyOf 2)nullAlternativeBulk import session the candidate came from.
imported_idJSONOptional
imported_id (anyOf 1)stringAlternativeExternal identifier from the import source.
imported_id (anyOf 2)nullAlternativeExternal identifier from the import source.
last_namestringRequired within parentCandidate's last name.
linkedin_profile_urlJSONRequired within parent
linkedin_profile_url (anyOf 1)stringAlternativeCandidate's LinkedIn profile URL.
linkedin_profile_url (anyOf 2)nullAlternativeCandidate's LinkedIn profile URL.
numeric_idJSONRequired within parent
numeric_id (anyOf 1)integerAlternativeNumeric identifier for the candidate.
numeric_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
origin_source_slugJSONRequired within parent
origin_source_slug (anyOf 1)stringAlternativeHow the candidate first entered the ATS.
origin_source_slug (anyOf 2)nullAlternativeHow the candidate first entered the ATS.
phone_numberJSONRequired within parent
phone_number (anyOf 1)stringAlternativeCandidate's phone number.
phone_number (anyOf 2)nullAlternativeCandidate's phone number.
pic_urlJSONRequired within parent
pic_url (anyOf 1)stringAlternativeURL of the candidate's profile picture.
pic_url (anyOf 2)nullAlternativeURL of the candidate's profile picture.
referred_by_hris_organization_user_idJSONOptional
referred_by_hris_organization_user_id (anyOf 1)stringAlternativeEmployee who referred the candidate.
Format: uuid
referred_by_hris_organization_user_id (anyOf 2)nullAlternativeEmployee who referred the candidate.
Format: uuid
updated_atstringRequired within parentWhen the candidate was last updated.
Format: date-time

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

Retrieve an ATS candidate — 200 response body — data applications item

FieldTypePresenceDescription and constraints
$objectRootAn application of the candidate.
archivation_reason_idJSONRequired within parent
archivation_reason_id (anyOf 1)stringAlternativeReason the application was archived; null unless archived.
Format: uuid
archivation_reason_id (anyOf 2)nullAlternativeReason the application was archived; null unless archived.
Format: uuid
created_atstringRequired within parentWhen the application was created.
Format: date-time
current_application_interview_plan_stageJSONRequired within parentWhere the application is now.
current_application_interview_plan_stage (anyOf 1)ModelAlternativeExpand Retrieve an ATS candidate — 200 response body — data applications item current application interview plan stage Where the application is now
current_application_interview_plan_stage (anyOf 2)nullAlternative
hired_atJSONRequired within parent
hired_at (anyOf 1)stringAlternativeWhen the application reached the hired stage; null otherwise.
Format: date-time
hired_at (anyOf 2)nullAlternativeWhen the application reached the hired stage; null otherwise.
Format: date-time
idstringRequired within parentApplication identifier.
Format: uuid
jobModelRequired within parentExpand Retrieve an ATS candidate — 200 response body — data applications item job
Job of the application.
moved_to_current_stage_atstringRequired within parentWhen the application entered its current stage.
Format: date-time
numeric_idJSONRequired within parent
numeric_id (anyOf 1)integerAlternativeApplication numeric identifier.
numeric_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentWhen the application was last updated.
Format: date-time

Referenced models: Retrieve an ATS candidate — 200 response body — data applications item job, Retrieve an ATS candidate — 200 response body — data applications item current application interview plan stage Where the application is now

Retrieve an ATS candidate — 200 response body — data applications item current application interview plan stage Where the application is now

FieldTypePresenceDescription and constraints
$objectRootWhere the application 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 Retrieve an ATS candidate — 200 response body — data applications item current application interview plan stage Where the application is now interview plan stage The current interview plan stage
interview_plan_stage (anyOf 2)nullAlternative

Referenced models: Retrieve an ATS candidate — 200 response body — data applications item current application interview plan stage Where the application is now interview plan stage The current interview plan stage

Retrieve an ATS candidate — 200 response body — data applications item current application interview plan stage Where the application is now interview plan stage The current interview plan stage

FieldTypePresenceDescription and constraints
$objectRootThe current interview plan stage.
category_type_slugstringRequired within parentStage category: lead, active or completed.
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
namestringRequired within parentCustomer-defined stage name.
position_numberJSONRequired within parent
position_number (anyOf 1)integerAlternativePosition of the stage in the interview plan.
position_number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve an ATS candidate — 200 response body — data applications item job

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

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

FieldTypePresenceDescription and constraints
$objectRootA document attached to the candidate.
ai_summaryJSONRequired within parent
ai_summary (anyOf 1)stringAlternativeAI-generated summary of the document (CVs only); null when not yet generated.
ai_summary (anyOf 2)nullAlternativeAI-generated summary of the document (CVs only); null when not yet generated.
attachment_type_slugstringRequired within parentKind of attachment.
Known values: CV, LOGO, OFFER_LETTER, OTHER
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeWhen the file was attached.
Format: date-time
created_at (anyOf 2)nullAlternativeWhen the file was attached.
Format: date-time
file_content_typestringRequired within parentMIME type of the file.
file_namestringRequired within parentOriginal file name.
idstringRequired within parentAttachment identifier (use GET /rest/ats/attachments for a download URL).
Format: uuid

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

FieldTypePresenceDescription and constraints
$objectRootA tag applied to the candidate.
idstringRequired within parentCandidate tag record identifier.
Format: uuid
tagModelRequired within parentExpand Retrieve an ATS candidate — 200 response body — data candidate tags item tag
The tag.

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

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

FieldTypePresenceDescription and constraints
$objectRootThe tag.
idstringRequired within parentTag identifier.
Format: uuid
labelstringRequired within parentTag label.

Retrieve average time per interview plan stage — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentAverage time applications spent in each interview plan stage.
data[]ModelEach itemExpand Retrieve average time per interview plan stage — 200 response body — data item
has_morebooleanRequired within parentAlways false: the result is a single aggregate page.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeAlways null: the result is a single aggregate page.
next_cursor (anyOf 2)nullAlternativeAlways null: the result is a single aggregate page.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeNumber of rows in data.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve average time per interview plan stage — 200 response body — data item

Retrieve average time per interview plan stage — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
average_secondsJSONRequired within parent
average_seconds (anyOf 1)numberAlternativeAverage seconds an application spent in the stage before leaving it, excluding time the job was paused
Format: double
average_seconds (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
interview_plan_stage_namestringRequired within parentCustomer-defined stage name. Stages with the same name in different interview plans are reported once.

Retrieve average time per interview plan stage — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
job_idsarrayOptional
job_ids[]stringEach itemFormat: uuid
hiring_member_hou_idsarrayOptional
hiring_member_hou_ids[]stringEach itemFormat: uuid
interview_plan_idsarrayOptional
interview_plan_ids[]stringEach itemFormat: uuid
department_idsarrayOptional
department_ids[]stringEach itemFormat: uuid
team_idsarrayOptional
team_ids[]stringEach itemFormat: uuid
employment_type_idsarrayOptional
employment_type_ids[]stringEach itemFormat: uuid
location_idsarrayOptional
location_ids[]stringEach itemFormat: uuid
candidate_tag_idsarrayOptional
candidate_tag_ids[]stringEach itemFormat: uuid
candidate_tag_ids_operatorstringOptionalOne of: ANY, ALL
source_slugsarrayOptional
source_slugs[]stringEach itemMaximum length: 50
job_statusesarrayOptional
job_statuses[]stringEach itemOne of: DRAFT, WAITING_FOR_APPROVAL, APPROVED, NOT_APPROVED, OPEN, PAUSED, CLOSED, ARCHIVED
work_arrangementsarrayOptional
work_arrangements[]stringEach itemOne of: ON_SITE, HYBRID, REMOTE
date_range_startstringOptionalFormat: date-time
date_range_endstringOptionalFormat: date-time
workspace_idsarrayOptional
workspace_ids[]stringEach itemFormat: uuid

Retrieve current application counts per interview plan stage — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentCurrent application counts per interview plan stage, ordered by stage position.
data[]ModelEach itemExpand Retrieve current application counts per interview plan stage — 200 response body — data item
has_morebooleanRequired within parentAlways false: the result is a single aggregate page.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeAlways null: the result is a single aggregate page.
next_cursor (anyOf 2)nullAlternativeAlways null: the result is a single aggregate page.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeNumber of rows in data.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve current application counts per interview plan stage — 200 response body — data item

Retrieve current application counts per interview plan stage — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
applications_countJSONRequired within parent
applications_count (anyOf 1)integerAlternativeApplications currently in this stage
applications_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
category_type_slugstringRequired within parentCategory of the stage
Known values: LEAD, ACTIVE, COMPLETED
default_type_slugJSONOptional
default_type_slug (anyOf 1)stringAlternativeBuilt-in stage type (new_lead, application_review, offer, hired, archived); null for custom stages
default_type_slug (anyOf 2)nullAlternativeBuilt-in stage type (new_lead, application_review, offer, hired, archived); null for custom stages
interview_plan_stage_namestringRequired within parentCustomer-defined stage name
job_idJSONRequired within parent
job_id (anyOf 1)stringAlternativeJob the count belongs to. Set only when job_ids is passed; otherwise counts are summed across jobs and this is null.
Format: uuid
job_id (anyOf 2)nullAlternativeJob the count belongs to. Set only when job_ids is passed; otherwise counts are summed across jobs and this is null.
Format: uuid
position_numberJSONRequired within parent
position_number (anyOf 1)integerAlternativePosition of the stage in its interview plan
position_number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve suggested ATS email templates — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve suggested ATS email templates — 200 response body — data

Referenced models: Retrieve suggested ATS email templates — 200 response body — data

Retrieve suggested ATS email templates — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
frequently_usedarrayRequired within parentTemplates the authenticated user sent most often recently, most used first.
frequently_used[]ModelEach itemExpand Retrieve suggested ATS email templates — 200 response body — data frequently used item
stage_suggestionsJSONRequired within parentTemplates the organization sends most at the requested stage. Null when no stage was given or the stage has too little send history to suggest from.
stage_suggestions (anyOf 1)ModelAlternativeExpand Retrieve suggested ATS email templates — 200 response body — data stage suggestions items, stage name
stage_suggestions (anyOf 2)nullAlternative

Referenced models: Retrieve suggested ATS email templates — 200 response body — data frequently used item, Retrieve suggested ATS email templates — 200 response body — data stage suggestions items, stage name

Retrieve suggested ATS email templates — 200 response body — data frequently used item

FieldTypePresenceDescription and constraints
$objectRoot
email_templateModelRequired within parentExpand Retrieve suggested ATS email templates — 200 response body — data frequently used item email template
send_countJSONRequired within parent
send_count (anyOf 1)integerAlternativeHow many times the template was sent in the trailing window
send_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve suggested ATS email templates — 200 response body — data frequently used item email template

Retrieve suggested ATS email templates — 200 response body — data frequently used item email template

FieldTypePresenceDescription and constraints
$objectRoot
bodystringRequired within parentEmail body as HTML with ${{token}} placeholders
idstringRequired within parentEmail template ID
Format: uuid
subjectstringRequired within parentEmail subject with ${{token}} placeholders
titlestringRequired within parentEmail template title
typeModelRequired within parentExpand Retrieve suggested ATS email templates — 200 response body — data frequently used item email template type
Template type

Referenced models: Retrieve suggested ATS email templates — 200 response body — data frequently used item email template type

Retrieve suggested ATS email templates — 200 response body — data frequently used item email template type

FieldTypePresenceDescription and constraints
$stringRootTemplate type
Known values: CUSTOM, DEFAULT_APPLICATION_CONFIRMATION, DEFAULT_ARCHIVE, DEFAULT_OFFER, DEFAULT_CANDIDATE_INTERVIEW_SCHEDULING, DEFAULT_QUESTIONNAIRE, DEFAULT_REFERRAL_CONFIRMATION, DEFAULT_DOCUMENT, DEFAULT_INTERVIEW_SCHEDULED_CANDIDATE, DEFAULT_INTERVIEW_SCHEDULED_INTERVIEWERS, DEFAULT_INTERVIEW_SCHEDULED_RECRUITERS, DEFAULT_INTERVIEW_RESCHEDULED_CANDIDATE, DEFAULT_INTERVIEW_RESCHEDULED_INTERVIEWERS, DEFAULT_INTERVIEW_RESCHEDULED_RECRUITERS, DEFAULT_INTERVIEW_CANCELLED_CANDIDATE, DEFAULT_INTERVIEW_CANCELLED_INTERVIEWERS, DEFAULT_INTERVIEW_CANCELLED_RECRUITERS, DEFAULT_INTERVIEWER_ADDED, DEFAULT_INTERVIEWER_REMOVED, DEFAULT_INTERVIEWERS_CHANGED_RECRUITERS, DEFAULT_INTERVIEW_RESCHEDULE_REQUEST_CANDIDATE, DEFAULT_INTERVIEW_LOCATION_UPDATED_CANDIDATE

Retrieve suggested ATS email templates — 200 response body — data stage suggestions items, stage name

FieldTypePresenceDescription and constraints
$objectRootTemplates the organization sends most at the requested stage. Null when no stage was given or the stage has too little send history to suggest from.
itemsarrayRequired within parentSuggested templates, most used first.
items[]ModelEach itemExpand Retrieve suggested ATS email templates — 200 response body — data frequently used item
stage_namestringRequired within parentCustomer-defined stage name

Referenced models: Retrieve suggested ATS email templates — 200 response body — data frequently used item

Retrieve the ATS activity timeline — 200 response body

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

Referenced models: Retrieve the ATS activity timeline — 200 response body — data item

Retrieve the ATS activity timeline — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
application_idJSONOptional
application_id (anyOf 1)stringAlternativeApplication the change relates to, if any
Format: uuid
application_id (anyOf 2)nullAlternativeApplication the change relates to, if any
Format: uuid
candidate_idJSONOptional
candidate_id (anyOf 1)stringAlternativeCandidate the change relates to, if any
Format: uuid
candidate_id (anyOf 2)nullAlternativeCandidate the change relates to, if any
Format: uuid
categorystringRequired within parentKind of record that changed
Known values: JOB, OFFER, JOB_POSTING, CANDIDATE, APPLICATION, JOB_ACTIVITY, SCHEDULED_INTERVIEW, APPLICATION_ACTIVITY, OPENING, COMPENSATION, CANDIDATE_EMAIL_BLOCKLIST_ENTRY, ORGANIZATION_SETTINGS, CANDIDATE_FOLLOW_UP_REMINDER
changesarrayRequired within parentFields that changed. Empty for events that carry no field changes.
changes[]ModelEach itemExpand Retrieve the ATS activity timeline — 200 response body — data item changes item
created_atstringRequired within parentWhen the change happened
Format: date-time
created_by_hris_organization_user_idJSONOptional
created_by_hris_organization_user_id (anyOf 1)stringAlternativeHRIS organization user who made the change. Null for changes made by the system or an automation.
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeHRIS organization user who made the change. Null for changes made by the system or an automation.
Format: uuid
idstringRequired within parentUnique identifier of the entry
Format: uuid
job_idJSONOptional
job_id (anyOf 1)stringAlternativeJob the change relates to, if any
Format: uuid
job_id (anyOf 2)nullAlternativeJob the change relates to, if any
Format: uuid
loggable_entity_idstringRequired within parentID of the record that changed
Format: uuid
operation_typeModelRequired within parentExpand Retrieve the ATS activity timeline — 200 response body — data item operation type
What happened to the record

Referenced models: Retrieve the ATS activity timeline — 200 response body — data item changes item, Retrieve the ATS activity timeline — 200 response body — data item operation type

Retrieve the ATS activity timeline — 200 response body — data item changes item

FieldTypePresenceDescription and constraints
$objectRoot
afterJSONRequired within parent
after (anyOf 1)stringAlternativeValue after the change. Non-string values are JSON-encoded. Null when the field was cleared.
after (anyOf 2)nullAlternativeValue after the change. Non-string values are JSON-encoded. Null when the field was cleared.
beforeJSONRequired within parent
before (anyOf 1)stringAlternativeValue before the change. Non-string values are JSON-encoded. Null when the field was not set.
before (anyOf 2)nullAlternativeValue before the change. Non-string values are JSON-encoded. Null when the field was not set.
fieldstringRequired within parentName of the changed field

Retrieve the ATS activity timeline — 200 response body — data item operation type

FieldTypePresenceDescription and constraints
$stringRootWhat happened to the record
Known values: JOB_UPDATED, JOB_HIRING_MEMBER_ADDED, JOB_HIRING_MEMBER_REMOVED, JOB_HIRING_MEMBER_UPDATED, OFFER_CREATED, OFFER_ACCEPTED, OFFER_DECLINED, OFFER_SUBMITTED_FOR_APPROVAL, OFFER_APPROVED, OFFER_APPROVAL_REJECTED, OFFER_DELETED, OFFER_UPDATED, OFFER_SENT, OFFER_RESENT, OFFER_SENT_OUTSIDE_DEEL, OFFER_RECORDED, OFFER_ACCEPTANCE_UNDONE, OFFER_DECLINE_UNDONE, JOB_POSTING_CREATED, JOB_POSTING_UPDATED, JOB_POSTING_PUBLISHED, JOB_POSTING_UNPUBLISHED, JOB_POSTING_ARCHIVED, JOB_POSTING_PUBLICATION_UPDATED, JOB_POSTING_AUDIENCE_UPDATED, COMPENSATION_CREATED, COMPENSATION_UPDATED, COMPENSATION_DELETED, CANDIDATE_DELETED, CANDIDATE_ANONYMIZED, CANDIDATE_AUTOMATICALLY_TAGGED, CANDIDATE_CREATED, CANDIDATE_AUTO_MERGED, CANDIDATE_UPDATED, CANDIDATE_LOCATION_UPDATED, APPLICATION_TRANSITIONED, APPLICATION_AUTO_TRANSITIONED, JOB_ACTIVITY_CREATED, JOB_ACTIVITY_UPDATED, JOB_ACTIVITY_DELETED, INTERVIEW_SCHEDULED, INTERVIEWER_ADDED, INTERVIEWER_REMOVED, INTERVIEW_UPDATED, INTERVIEW_CANCELLED, INTERVIEW_SLOT_REQUEST_SENT, INTERVIEW_SLOTS_SUBMITTED, INTERVIEW_MANUALLY_LOGGED, APPLICATION_EVALUATION_PARTICIPANT_ADDED, APPLICATION_EVALUATION_PARTICIPANT_REMOVED, APPLICATION_EVALUATION_FEEDBACK_SUBMITTED, APPLICATION_ACTIVITY_FEEDBACK_DISMISSED, APPLICATION_ACTIVITY_FEEDBACK_DISMISSAL_REVERTED, APPLICATION_ACTIVITY_CREATED, APPLICATION_ACTIVITY_DELETED, EMAIL_SENT, EMAIL_SCHEDULED, AUTOMATED_EMAIL_SENT, JOB_INTERVIEW_PLAN_UPDATED, OFFER_EXPIRED, OFFER_PENDING_CREATION, OPENING_CREATED, OPENING_UPDATED, OPENING_DELETED, OPENING_SUBMITTED_FOR_APPROVAL, OPENING_APPROVED, OPENING_REJECTED, APPLICATION_SOURCE_UPDATED, APPLICATION_SOURCE_CHANNEL_UPDATED, JOB_PRIVATE_NOTE_CREATED, JOB_PRIVATE_NOTE_UPDATED, JOB_PRIVATE_NOTE_DELETED, CANDIDATE_EMAIL_BLOCKLISTED, CANDIDATE_EMAIL_UNBLOCKLISTED, ORGANIZATION_SETTINGS_UPDATED, SECURITY_STATE_CHANGED, CANDIDATE_FOLLOW_UP_REMINDER_CREATED, CANDIDATE_FOLLOW_UP_REMINDER_UPDATED, CANDIDATE_FOLLOW_UP_REMINDER_COMPLETED, CANDIDATE_FOLLOW_UP_REMINDER_DELETED

Retrieve the organization's offer settings — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve the organization's offer settings — 200 response body — data
The organization's offer settings

Referenced models: Retrieve the organization's offer settings — 200 response body — data

Retrieve the organization's offer settings — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe organization's offer settings
approval_exempt_fieldsarrayRequired within parentOffer fields whose edits do not send an approved offer back to approval
approval_exempt_fields[]stringEach itemOffer field
Known values: WORKER_TYPE, COMPENSATION_AMOUNT, COMPENSATION_CURRENCY, COMPENSATION_PERIOD_SLUG, JOB_TITLE, COUNTRY_CODE, START_DATE, EXPIRES_AT, CUSTOM_FIELDS, ADDITIONAL_DETAILS, OPENING_ID
default_approval_rule_idJSONRequired within parent
default_approval_rule_id (anyOf 1)stringAlternativeID of the default approval rule for offers
Format: uuid
default_approval_rule_id (anyOf 2)nullAlternativeID of the default approval rule for offers
Format: uuid
is_approval_requiredbooleanRequired within parentWhether every offer must go through an approval

Send an email draft to a candidate — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Send an email draft to a candidate — 201 response body — data
The email sent from the draft

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

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

FieldTypePresenceDescription and constraints
$objectRootThe email sent from the draft
application_idJSONRequired within parent
application_id (anyOf 1)stringAlternativeThe application the email is about, or null for an email about the candidate only
Format: uuid
application_id (anyOf 2)nullAlternativeThe application the email is about, or null for an email about the candidate only
Format: uuid
bccarrayRequired within parentBCC recipients, resolved to addresses
bcc[]stringEach itemFormat: email
bodystringRequired within parentThe rich text HTML body as sent
candidate_idstringRequired within parentThe candidate the email was sent to
Format: uuid
ccarrayRequired within parentCC recipients, resolved to addresses
cc[]stringEach itemFormat: email
fromstringRequired within parentThe sender the email went out as
idstringRequired within parentThe unique identifier of the sent email, the same as the draft it was sent from
Format: uuid
sent_atJSONRequired within parent
sent_at (anyOf 1)stringAlternativeThe timestamp when the email was sent
Format: date-time
sent_at (anyOf 2)nullAlternativeThe timestamp when the email was sent
Format: date-time
subjectstringRequired within parentThe subject as sent
toarrayRequired within parentPrimary recipients, with dynamic recipients such as the candidate resolved to addresses
to[]stringEach itemFormat: email

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

FieldTypePresenceDescription and constraints
$objectRoot
email_draft_idstringRequired within parentID of the caller's own email draft to send. Sending the same draft again returns the email already sent.
Format: uuid
expected_updated_atstringOptionalOptional precondition: the draft's updated_at as last previewed. If the draft changed since, nothing is sent and a 409 precondition_failed is returned.
Format: date-time

Set tags in bulk — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Set tags in bulk — 200 response body — data
Resolved tags grouped by tag group.

Referenced models: Set tags in bulk — 200 response body — data

Set tags in bulk — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootResolved tags grouped by tag group.
candidate_tagsarrayOptional
candidate_tags[]ModelEach itemExpand Set tags in bulk — 200 response body — data job tags item
job_tagsarrayOptional
job_tags[]ModelEach itemExpand Set tags in bulk — 200 response body — data job tags item
opening_tagsarrayOptional
opening_tags[]ModelEach itemExpand Set tags in bulk — 200 response body — data job tags item

Referenced models: Set tags in bulk — 200 response body — data job tags item

Set tags in bulk — 200 response body — data job tags item

FieldTypePresenceDescription and constraints
$objectRoot
tag_idstringRequired within parentUnique identifier of the resolved tag.
Format: uuid
tag_namestringRequired within parentThe tag label.

Set tags in bulk — request body — body data

FieldTypePresenceDescription and constraints
$JSONRootAt least one tag group must be provided. Include tag_id to update an existing tag label, or omit it to create or match case-insensitively.
$ (anyOf 1)ModelAlternativeExpand Set tags in bulk — request body — body data candidate tags
$ (anyOf 2)ModelAlternativeExpand Set tags in bulk — request body — body data job tags
$ (anyOf 3)ModelAlternativeExpand Set tags in bulk — request body — body data opening tags

Referenced models: Set tags in bulk — request body — body data candidate tags, Set tags in bulk — request body — body data job tags, Set tags in bulk — request body — body data opening tags

Set tags in bulk — request body — body data candidate tags

FieldTypePresenceDescription and constraints
$objectRoot
candidate_tagsJSONRequired within parentAny type

Set tags in bulk — request body — body data job tags

FieldTypePresenceDescription and constraints
$objectRoot
job_tagsJSONRequired within parentAny type

Set tags in bulk — request body — body data opening tags

FieldTypePresenceDescription and constraints
$objectRoot
opening_tagsJSONRequired within parentAny type

Set the hiring team role of a person on a job — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Set the hiring team role of a person on a job — 200 response body — data
The person's hiring team membership after the change

Referenced models: Set the hiring team role of a person on a job — 200 response body — data

Set the hiring team role of a person on a job — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe person's hiring team membership after the change
hris_organization_user_idstringRequired within parentHRIS organization user ID of the person
Format: uuid
job_idstringRequired within parentID of the job
Format: uuid
role_idJSONRequired within parent
role_id (anyOf 1)JSONAlternative
role_id (anyOf 1) (anyOf 1)integerAlternativeRole the person now holds on the job (-60000 is Recruiter, -60005 is Hiring Coordinator and -60002 is Hiring Manager), or null when they are not on the hiring team.
role_id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
role_id (anyOf 2)nullAlternativeRole the person now holds on the job (-60000 is Recruiter, -60005 is Hiring Coordinator and -60002 is Hiring Manager), or null when they are not on the hiring team.

Set the hiring team role of a person on a job — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
expected_role_idinteger or nullOptionalOptional precondition: the person's role_id on the job as last read, or null when they were not on the hiring team. If it changed since, nothing changes and a 409 precondition_failed is returned.
role_idJSONRequired within parentRole the person should hold on the job (-60000 is Recruiter, -60005 is Hiring Coordinator and -60002 is Hiring Manager), or null to remove them from the hiring team.
role_id (oneOf 1)stringAlternativeRole the person should hold on the job (-60000 is Recruiter, -60005 is Hiring Coordinator and -60002 is Hiring Manager), or null to remove them from the hiring team.
One of: -60000, -60005, -60002
role_id (oneOf 2)nullAlternative

Set the time of an interview — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Set the time of an interview — 200 response body — data
The scheduled interview

Referenced models: Set the time of an interview — 200 response body — data

Set the time of an interview — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe scheduled interview
application_activity_idstringRequired within parentID of the interview scheduling activity of the application
Format: uuid
idstringRequired within parentUnique identifier of the interview
Format: uuid
starts_atJSONRequired within parent
starts_at (anyOf 1)stringAlternativeStart of the interview as booked
Format: date-time
starts_at (anyOf 2)nullAlternativeStart of the interview as booked
Format: date-time

Set the time of an interview — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
expected_starts_atstring or nullOptionalOptional precondition: the interview's starts_at as last read, or null when it was not scheduled. If it changed since, nothing is booked and a 409 precondition_failed is returned.
Format: date-time
starts_atstringRequired within parentStart of the interview, normally the start_time of an available slot
Format: date-time
timezonestringRequired within parentIANA timezone of the interview, used in the invitations

Update ATS Application — 200 response body

FieldTypePresenceDescription and constraints
$objectRootUpdated application response
dataModelRequired within parentExpand Update ATS Application — 200 response body — data

Referenced models: Update ATS Application — 200 response body — data

Update ATS Application — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentApplication unique identifier
Format: uuid
source_slugJSONRequired within parent
source_slug (anyOf 1)stringAlternativeThe application source slug in uppercase
source_slug (anyOf 2)nullAlternativeThe application source slug in uppercase
updated_atstringRequired within parentLast update timestamp
Format: date-time

Update ATS Application — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
expected_updated_atstringOptionalOptional precondition: the application's updated_at as last read. If the application changed since, nothing is updated and a 409 precondition_failed is returned.
Format: date-time
source_slugstringRequired within parentThe application source. Accepts any active source slug of the organization, e.g. SOURCED_INTERNALLY, SOURCED_EXTERNALLY, INTERNAL_REFERRAL_AWARE, INTERNAL_REFERRAL_NOT_AWARE, EXTERNAL_CAREER_PAGE or a custom source slug (case-insensitive)

Update ATS Candidate — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
citystring or nullOptionalCity the candidate currently lives in
country_codestring or nullOptionalISO 3166-1 alpha-2 code of the country the candidate currently lives in
emailstringOptionalThe candidate's email address
Format: email
expected_updated_atstringOptionalOptional precondition: the candidate's updated_at as last read. If the candidate changed since, nothing is updated and a 409 precondition_failed is returned. Does not count as a field to update.
Format: date-time
first_namestringOptionalThe candidate's first name
last_namestringOptionalThe candidate's last name
linkedin_profile_urlstringOptionalThe candidate's LinkedIn profile URL
Format: uri
origin_source_slugstringOptionalThe candidate's origin source slug. Accepts any active source slug of the organization, e.g. sourced_internally, sourced_externally, external_career_page, linkedin_basic or a custom source slug (case-insensitive)
phone_numberstringOptionalThe candidate's phone number
pic_urlstringOptionalThe candidate's picture URL
Format: uri

Upload ATS Candidate CV — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Upload ATS Candidate CV — 201 response body — data

Referenced models: Upload ATS Candidate CV — 201 response body — data

Upload ATS Candidate CV — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
attachable_idstringOptionalUnique identifier of the entity the file is attached to
Format: uuid
attachable_type_slugstringRequired within parentType of the entity the file is attached to
Known values: CANDIDATE
attachment_type_slugstringRequired within parentType of the attachment
Known values: CV, LOGO, OFFER_LETTER, OTHER
created_atstringOptionalTimestamp when the attachment was created
Format: date-time
file_content_typeJSONOptional
file_content_type (anyOf 1)stringAlternativeContent type of the attached file
file_content_type (anyOf 2)nullAlternativeContent type of the attached file
file_namestringRequired within parentName of the attached file
idstringRequired within parentUnique identifier for the attachment
Format: uuid
updated_atstringOptionalTimestamp when the attachment was last updated
Format: date-time

Upload an ATS attachment file — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Upload an ATS attachment file — 201 response body — data

Referenced models: Upload an ATS attachment file — 201 response body — data

Upload an ATS attachment file — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
ai_summaryJSONOptional
ai_summary (anyOf 1)stringAlternativeAI-generated summary of the attachment
ai_summary (anyOf 2)nullAlternativeAI-generated summary of the attachment
attachable_idstringOptionalUnique identifier of the entity the file is attached to
Format: uuid
attachable_type_slugstringRequired within parentType of the entity the file is attached to
Known values: CANDIDATE, OFFER, JOB_ACTIVITY
attachment_type_slugstringRequired within parentType of the attachment
Known values: CV, LOGO, OFFER_LETTER, OTHER
created_atstringOptionalTimestamp when the attachment was created
Format: date-time
created_by_hris_organization_user_idJSONOptional
created_by_hris_organization_user_id (anyOf 1)stringAlternativeUser ID who created the attachment
Format: uuid
created_by_hris_organization_user_id (anyOf 2)nullAlternativeUser ID who created the attachment
Format: uuid
file_content_typestringRequired within parentContent type of the attached file
file_namestringRequired within parentName of the attached file
idstringRequired within parentUnique identifier for the attachment
Format: uuid
updated_atstringOptionalTimestamp when the attachment was last updated
Format: date-time

Validate offer terms for an application — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Validate offer terms for an application — 200 response body — data
Outcome of the validation

Referenced models: Validate offer terms for an application — 200 response body — data

Validate offer terms for an application — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootOutcome of the validation
errorsarrayRequired within parentRules the terms break; empty when the terms are valid
errors[]ModelEach itemExpand Validate offer terms for an application — 200 response body — data errors item
is_validbooleanRequired within parentWhether the terms satisfy every rule

Referenced models: Validate offer terms for an application — 200 response body — data errors item

Validate offer terms for an application — 200 response body — data errors item

FieldTypePresenceDescription and constraints
$objectRoot
codestringRequired within parentMachine-readable code of the broken rule
fieldJSONRequired within parent
field (anyOf 1)stringAlternativeRequest field the error is about, or null when it concerns the terms as a whole
field (anyOf 2)nullAlternativeRequest field the error is about, or null when it concerns the terms as a whole
messagestringRequired within parentExplanation of the broken rule to show to the user

Validate offer terms for an application — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
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
job_titlestring or nullOptionalJob title offered to the candidate
start_datestringRequired within parentProposed start date of the candidate
Format: date-time
statestring or nullOptionalState or region code within the country, where the rules depend on it
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

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.