Skip to content

Deel: ATS offers schemas

4 Deel schemas with complete fields and constraints.

← ATS offers operations · All schemas

Retrieve a list of ATS offers — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptionalPage of offers.
data[]ModelEach itemExpand Retrieve a list of ATS offers — 200 response body — data item
has_morebooleanOptionalIndicates if there are more items to fetch.
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternativeCursor for the next page of results
next_cursor (anyOf 2)nullAlternativeCursor for the next page of results
total_countJSONOptional
total_count (anyOf 1)numberAlternativeTotal number of offers
Format: double
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

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

FieldTypePresenceDescription and constraints
$objectRoot
additional_detailsJSONOptional
additional_details (anyOf 1)stringAlternativeAdditional details about the offer
additional_details (anyOf 2)nullAlternativeAdditional details about the offer
applicationModelOptionalExpand 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_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 a list of ATS offers — 200 response body — data item custom fields item
emailJSONOptionalEmail details
email (anyOf 1)ModelAlternativeExpand Retrieve a list of ATS offers — 200 response body — data item email Email details
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
idstringOptionalUnique 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_statusstringOptionalOffer 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 a list of ATS offers — 200 response body — data item custom fields item, Retrieve a list of ATS offers — 200 response body — data item email Email details

Retrieve a list of ATS offers — 200 response body — data item 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
namestringRequired within parentCustom field name
requiredbooleanRequired within parentWhether the custom field is required
typestringRequired within parentType of custom field
Known values: TEXT, PERCENTAGE, LIST, MULTISELECT, DATE, NUMBER, CURRENCY, HYPERLINK

Retrieve a list of ATS offers — 200 response body — data item email Email details

FieldTypePresenceDescription and constraints
$objectRootEmail details
bodystringRequired within parentEmail body
idstringRequired within parentUnique identifier for the email
Format: uuid
recipient_bccJSONOptional
recipient_bcc (anyOf 1)stringAlternativeBlind-carbon-copy recipient email address
Format: email
recipient_bcc (anyOf 2)nullAlternativeBlind-carbon-copy recipient email address
Format: email
recipient_ccJSONOptional
recipient_cc (anyOf 1)stringAlternativeCarbon-copy recipient email address
Format: email
recipient_cc (anyOf 2)nullAlternativeCarbon-copy recipient email address
Format: email
recipient_tostringRequired within parentPrimary recipient email address
Format: email
sender_namestringRequired within parentSender name
subjectstringRequired within parentEmail subject

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.