Skip to content

Deel: ATS job postings schemas

17 Deel schemas with complete fields and constraints.

← ATS job postings operations · All schemas

Retrieve ATS job posting — 200 response body

FieldTypePresenceDescription and constraints
$objectRootSuccessful operation.
dataModelOptionalExpand Retrieve ATS job posting — 200 response body — data
Job posting with nested job details and publication status.

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

Retrieve ATS job posting — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootJob posting with nested job details and publication status.
application_formJSONOptionalApplication form assigned to the job posting
application_form (anyOf 1)ModelAlternativeExpand Retrieve ATS job posting — 200 response body — data application form Application form assigned to the job posting
application_form (anyOf 2)nullAlternative
created_atstringRequired within parentCreation timestamp
Format: date-time
idstringRequired within parentUnique identifier for the job posting
Format: uuid
is_compensation_visiblebooleanRequired within parentIndicates if compensation details are visible to candidates
jobModelRequired within parentExpand Retrieve ATS job posting — 200 response body — data job
Associated job information
job_idstringRequired within parentIdentifier of the underlying job this posting belongs to.
Format: uuid
publicationsarrayRequired within parentPublication rows for this posting, one per job board integration, with current state.
publications[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data publications item
richtext_descriptionJSONRequired within parent
richtext_description (anyOf 1)stringAlternativeRich text description of the job posting
richtext_description (anyOf 2)nullAlternativeRich text description of the job posting
titlestringRequired within parentJob posting title
Maximum length: 200
updated_atstringRequired within parentLast update timestamp
Format: date-time

Referenced models: Retrieve ATS job posting — 200 response body — data application form Application form assigned to the job posting, Retrieve ATS job posting — 200 response body — data job, Retrieve ATS job posting — 200 response body — data publications item

Retrieve ATS job posting — 200 response body — data application form Application form assigned to the job posting

FieldTypePresenceDescription and constraints
$objectRootApplication form assigned to the job posting
idstringRequired within parentUnique identifier for the application form
Format: uuid
titlestringRequired within parentTitle of the application form

Retrieve ATS job posting — 200 response body — data job

FieldTypePresenceDescription and constraints
$objectRootAssociated job information
compensationJSONRequired within parentCompensation information for the job
compensation (anyOf 1)ModelAlternativeExpand Retrieve ATS job posting — 200 response body — data job compensation Compensation information for the job
compensation (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the job
Format: uuid
job_departmentsJSONOptional
job_departments (anyOf 1)arrayAlternativeDepartments associated with the job
job_departments (anyOf 1)[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item
job_departments (anyOf 2)nullAlternativeDepartments associated with the job
job_departments (anyOf 2)[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item
job_employment_typesarrayRequired within parentEmployment types associated with the job
job_employment_types[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data job job employment types item
job_locationsarrayRequired within parentLocations associated with the job
job_locations[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data job job locations item
job_teamsJSONOptional
job_teams (anyOf 1)arrayAlternativeTeams associated with the job
job_teams (anyOf 1)[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item
job_teams (anyOf 2)nullAlternativeTeams associated with the job
job_teams (anyOf 2)[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item

Referenced models: Retrieve ATS job posting — 200 response body — data job job employment types item, Retrieve ATS job posting — 200 response body — data job job locations item, Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item, Retrieve ATS job posting — 200 response body — data job compensation Compensation information for the job, Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item

Retrieve ATS job posting — 200 response body — data job compensation Compensation information for the job

FieldTypePresenceDescription and constraints
$objectRootCompensation information for the job
currency_iso_codestringRequired within parentCurrency ISO code for the compensation
idstringRequired within parentUnique identifier for the compensation record
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

Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item

FieldTypePresenceDescription and constraints
$objectRoot
departmentJSONOptional
department (anyOf 1)ModelAlternativeExpand Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item department id, name
department (anyOf 2)nullAlternative
idstringRequired within parentJob-department association row identifier.
Format: uuid

Referenced models: Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item department id, name

Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item department id, name

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalDepartment identifier.
Format: uuid
namestringOptionalDisplay name of the department.
Maximum length: 100

Retrieve ATS job posting — 200 response body — data job job employment types item

FieldTypePresenceDescription and constraints
$objectRoot
employment_typeModelRequired within parentExpand Retrieve ATS job posting — 200 response body — data job job employment types item employment type
Details for the employment type assigned to the job
idstringRequired within parentUnique identifier for the job employment type
Format: uuid

Referenced models: Retrieve ATS job posting — 200 response body — data job job employment types item employment type

Retrieve ATS job posting — 200 response body — data job job employment types item employment type

FieldTypePresenceDescription and constraints
$objectRootDetails for the employment type assigned to the job
idstringRequired within parentUnique identifier for the employment type
Format: uuid
namestringRequired within parentEmployment type name

Retrieve ATS job posting — 200 response body — data job job locations item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the job location
Format: uuid
locationModelRequired within parentExpand Retrieve ATS job posting — 200 response body — data job job locations item location
Details for the location assigned to the job

Referenced models: Retrieve ATS job posting — 200 response body — data job job locations item location

Retrieve ATS job posting — 200 response body — data job job locations item location

FieldTypePresenceDescription and constraints
$objectRootDetails for the location assigned to the job
idstringRequired within parentUnique identifier for the location
Format: uuid
namestringRequired within parentLocation name

Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier for the job team
Format: uuid
teamModelRequired within parentExpand Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item team
Details for the team assigned to the job

Referenced models: Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item team

Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item team

FieldTypePresenceDescription and constraints
$objectRootDetails for the team assigned to the job
idstringRequired within parentUnique identifier for the team
Format: uuid
namestringRequired within parentTeam name

Retrieve ATS job posting — 200 response body — data publications item

FieldTypePresenceDescription and constraints
$objectRootPublication information for different job boards
current_stateModelRequired within parentExpand Retrieve ATS job posting — 200 response body — data publications item current state
Current publication state details
idstringRequired within parentUnique identifier for the job posting publication
Format: uuid
job_boardModelRequired within parentExpand Retrieve ATS job posting — 200 response body — data publications item job board
Job board where the posting is published

Referenced models: Retrieve ATS job posting — 200 response body — data publications item job board, Retrieve ATS job posting — 200 response body — data publications item current state

Retrieve ATS job posting — 200 response body — data publications item current state

FieldTypePresenceDescription and constraints
$objectRootCurrent publication state details
created_atstringRequired within parentTimestamp when the publication was created
Format: date-time
created_byJSONOptional
created_by (anyOf 1)stringAlternativeUser who created the publication
Format: uuid
created_by (anyOf 2)nullAlternativeUser who created the publication
Format: uuid
error_messageJSONOptional
error_message (anyOf 1)stringAlternativeError message if publication failed
error_message (anyOf 2)nullAlternativeError message if publication failed
idstringRequired within parentUnique identifier for the publication state
Format: uuid
state_slugstringRequired within parentCurrent publication state
Known values: PUBLISHED_BASIC, PUBLISHED_PREMIUM, UNPUBLISHED, EXPIRED, IN_PROGRESS, FAILED

Retrieve ATS job posting — 200 response body — data publications item job board

FieldTypePresenceDescription and constraints
$objectRootJob board where the posting is published
idstringRequired within parentUnique identifier for the job board
Format: uuid

Retrieve ATS job postings — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve ATS job posting — 200 response body — data
has_morebooleanRequired within parentIndicates if there are more results available
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 postings
Minimum: 0
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve ATS job posting — 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.