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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Successful operation. |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job posting with nested job details and publication status. |
application_form | JSON | Optional | Application form assigned to the job posting |
application_form (anyOf 1) | Model | Alternative | Expand Retrieve ATS job posting — 200 response body — data application form Application form assigned to the job posting |
application_form (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Creation timestamp Format: date-time |
id | string | Required within parent | Unique identifier for the job posting Format: uuid |
is_compensation_visible | boolean | Required within parent | Indicates if compensation details are visible to candidates |
job | Model | Required within parent | Expand Retrieve ATS job posting — 200 response body — data job Associated job information |
job_id | string | Required within parent | Identifier of the underlying job this posting belongs to. Format: uuid |
publications | array | Required within parent | Publication rows for this posting, one per job board integration, with current state. |
publications[] | Model | Each item | Expand Retrieve ATS job posting — 200 response body — data publications item |
richtext_description | JSON | Required within parent | |
richtext_description (anyOf 1) | string | Alternative | Rich text description of the job posting |
richtext_description (anyOf 2) | null | Alternative | Rich text description of the job posting |
title | string | Required within parent | Job posting title Maximum length: 200 |
updated_at | string | Required within parent | Last 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Application form assigned to the job posting |
id | string | Required within parent | Unique identifier for the application form Format: uuid |
title | string | Required within parent | Title of the application form |
Retrieve ATS job posting — 200 response body — data job
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Associated job information |
compensation | JSON | Required within parent | Compensation information for the job |
compensation (anyOf 1) | Model | Alternative | Expand Retrieve ATS job posting — 200 response body — data job compensation Compensation information for the job |
compensation (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the job Format: uuid |
job_departments | JSON | Optional | |
job_departments (anyOf 1) | array | Alternative | Departments associated with the job |
job_departments (anyOf 1)[] | Model | Each item | Expand Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item |
job_departments (anyOf 2) | null | Alternative | Departments associated with the job |
job_departments (anyOf 2)[] | Model | Each item | Expand Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item |
job_employment_types | array | Required within parent | Employment types associated with the job |
job_employment_types[] | Model | Each item | Expand Retrieve ATS job posting — 200 response body — data job job employment types item |
job_locations | array | Required within parent | Locations associated with the job |
job_locations[] | Model | Each item | Expand Retrieve ATS job posting — 200 response body — data job job locations item |
job_teams | JSON | Optional | |
job_teams (anyOf 1) | array | Alternative | Teams associated with the job |
job_teams (anyOf 1)[] | Model | Each item | Expand Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item |
job_teams (anyOf 2) | null | Alternative | Teams associated with the job |
job_teams (anyOf 2)[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Compensation information for the job |
currency_iso_code | string | Required within parent | Currency ISO code for the compensation |
id | string | Required within parent | Unique identifier for the compensation record Format: uuid |
max_amount | JSON | Optional | |
max_amount (anyOf 1) | JSON | Alternative | |
max_amount (anyOf 1) (anyOf 1) | number | Alternative | Maximum compensation amount Format: double |
max_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_amount (anyOf 2) | null | Alternative | Maximum compensation amount Format: double |
min_amount | JSON | Optional | |
min_amount (anyOf 1) | JSON | Alternative | |
min_amount (anyOf 1) (anyOf 1) | number | Alternative | Minimum compensation amount Format: double |
min_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_amount (anyOf 2) | null | Alternative | Minimum compensation amount Format: double |
Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
department | JSON | Optional | |
department (anyOf 1) | Model | Alternative | Expand Retrieve ATS job posting — 200 response body — data job job departments Departments associated with the job item department id, name |
department (anyOf 2) | null | Alternative | |
id | string | Required within parent | Job-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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Department identifier. Format: uuid |
name | string | Optional | Display name of the department. Maximum length: 100 |
Retrieve ATS job posting — 200 response body — data job job employment types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employment_type | Model | Required within parent | Expand Retrieve ATS job posting — 200 response body — data job job employment types item employment type Details for the employment type assigned to the job |
id | string | Required within parent | Unique 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details for the employment type assigned to the job |
id | string | Required within parent | Unique identifier for the employment type Format: uuid |
name | string | Required within parent | Employment type name |
Retrieve ATS job posting — 200 response body — data job job locations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the job location Format: uuid |
location | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details for the location assigned to the job |
id | string | Required within parent | Unique identifier for the location Format: uuid |
name | string | Required within parent | Location name |
Retrieve ATS job posting — 200 response body — data job job teams Teams associated with the job item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier for the job team Format: uuid |
team | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details for the team assigned to the job |
id | string | Required within parent | Unique identifier for the team Format: uuid |
name | string | Required within parent | Team name |
Retrieve ATS job posting — 200 response body — data publications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Publication information for different job boards |
current_state | Model | Required within parent | Expand Retrieve ATS job posting — 200 response body — data publications item current state Current publication state details |
id | string | Required within parent | Unique identifier for the job posting publication Format: uuid |
job_board | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Current publication state details |
created_at | string | Required within parent | Timestamp when the publication was created Format: date-time |
created_by | JSON | Optional | |
created_by (anyOf 1) | string | Alternative | User who created the publication Format: uuid |
created_by (anyOf 2) | null | Alternative | User who created the publication Format: uuid |
error_message | JSON | Optional | |
error_message (anyOf 1) | string | Alternative | Error message if publication failed |
error_message (anyOf 2) | null | Alternative | Error message if publication failed |
id | string | Required within parent | Unique identifier for the publication state Format: uuid |
state_slug | string | Required within parent | Current 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job board where the posting is published |
id | string | Required within parent | Unique identifier for the job board Format: uuid |
Retrieve ATS job postings — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve ATS job posting — 200 response body — data |
has_more | boolean | Required within parent | Indicates if there are more results available |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page of results |
next_cursor (anyOf 2) | null | Alternative | Cursor for the next page of results |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of job postings Minimum: 0 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve ATS job posting — 200 response body — data