Deel: ATS candidates schemas
13 Deel schemas with complete fields and constraints.
← ATS candidates operations · All schemas
Create ATS Candidate — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create ATS Candidate — 200 response body — data |
Referenced models: Create ATS Candidate — 200 response body — data
Create ATS Candidate — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
anonymized_at | JSON | Optional | |
anonymized_at (anyOf 1) | string | Alternative | Timestamp when the candidate was anonymized Format: date-time |
anonymized_at (anyOf 2) | null | Alternative | Timestamp when the candidate was anonymized Format: date-time |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | City the candidate currently lives in |
city (anyOf 2) | null | Alternative | City the candidate currently lives in |
country_code | JSON | Optional | |
country_code (anyOf 1) | string | Alternative | ISO 3166-1 alpha-2 country the candidate currently lives in |
country_code (anyOf 2) | null | Alternative | ISO 3166-1 alpha-2 country the candidate currently lives in |
created_at | string | Required within parent | Timestamp when the candidate was created Format: date-time |
email | string | Required within parent | Email address of the candidate Format: email |
final_archivation_at | JSON | Optional | |
final_archivation_at (anyOf 1) | string | Alternative | Timestamp when the candidate was finally archived Format: date-time |
final_archivation_at (anyOf 2) | null | Alternative | Timestamp when the candidate was finally archived Format: date-time |
first_name | string | Required within parent | First name of the candidate |
id | string | Required within parent | Unique identifier for the candidate Format: uuid |
import_session_id | JSON | Optional | |
import_session_id (anyOf 1) | string | Alternative | Import session identifier |
import_session_id (anyOf 2) | null | Alternative | Import session identifier |
imported_id | JSON | Optional | |
imported_id (anyOf 1) | string | Alternative | Imported identifier |
imported_id (anyOf 2) | null | Alternative | Imported identifier |
last_name | string | Required within parent | Last name of the candidate |
linkedin_profile_url | JSON | Optional | |
linkedin_profile_url (anyOf 1) | string | Alternative | LinkedIn profile URL of the candidate |
linkedin_profile_url (anyOf 2) | null | Alternative | LinkedIn profile URL of the candidate |
numeric_id | JSON | Required within parent | |
numeric_id (anyOf 1) | integer | Alternative | Numeric identifier for the candidate |
numeric_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
origin_source_slug | JSON | Optional | |
origin_source_slug (anyOf 1) | string | Alternative | Origin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug) |
origin_source_slug (anyOf 2) | null | Alternative | Origin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug) |
phone_number | JSON | Optional | |
phone_number (anyOf 1) | string | Alternative | Phone number of the candidate |
phone_number (anyOf 2) | null | Alternative | Phone number of the candidate |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | Profile picture URL of the candidate |
pic_url (anyOf 2) | null | Alternative | Profile picture URL of the candidate |
source | JSON | Optional | |
source (anyOf 1) | string | Alternative | Source of the candidate |
source (anyOf 2) | null | Alternative | Source of the candidate |
updated_at | string | Required within parent | Timestamp when the candidate was last updated Format: date-time |
Create ATS Candidate — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | string or null | Optional | City the candidate currently lives in |
country_code | string or null | Optional | ISO 3166-1 alpha-2 code of the country the candidate currently lives in |
email | string | Required within parent | The candidate's email address Format: email |
first_name | string | Required within parent | The candidate's first name |
last_name | string | Required within parent | The candidate's last name |
linkedin_profile_url | string or null | Optional | The candidate's LinkedIn profile URL Format: uri |
origin_source_slug | string | Optional | The 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_number | string or null | Optional | The candidate's phone number |
pic_url | string or null | Optional | The candidate's picture URL Format: uri |
Create candidate tags — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of created candidate-tag associations. |
data[] | Model | Each item | Expand Create candidate tags — 201 response body — data item |
Referenced models: Create candidate tags — 201 response body — data item
Create candidate tags — 201 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
candidate_id | string | Required within parent | Unique identifier of the candidate. Format: uuid |
created_at | string | Required within parent | When the association was created. Format: date-time |
id | string | Required within parent | Unique identifier of the candidate-tag association. Format: uuid |
tag_id | string | Required within parent | Unique identifier of the tag. Format: uuid |
Retrieve paginated list of ATS Candidates — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of candidates |
data[] | Model | Each item | Expand Retrieve paginated list of ATS Candidates — 200 response body — data item |
has_more | boolean | Required within parent | Indicates if there are more items to fetch |
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 candidates Minimum: 0 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve paginated list of ATS Candidates — 200 response body — data item
Retrieve paginated list of ATS Candidates — 200 response body — data / item / applications / item / current_application_interview_plan_stage / status: ACTIVE, COMPLETED, PENDING, REJECTED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application_id | string | Required within parent | Unique identifier for the application Format: uuid |
created_at | string | Required within parent | Timestamp of when the current application interview plan stage was created Format: date-time |
id | string | Required within parent | Unique identifier for the current application interview plan stage Format: uuid |
interview_plan_stage | JSON | Optional | |
interview_plan_stage (anyOf 1) | Model | Alternative | Expand Retrieve paginated list of ATS Candidates — 200 response body — data / item / applications / item / current_application_interview_plan_stage / status: ACTIVE, COMPLETED, PENDING, REJECTED interview plan stage category type slug, default type slug, description, id, interview plan id, name, stage order |
interview_plan_stage (anyOf 2) | null | Alternative | |
interview_plan_stage_id | string | Required within parent | Unique identifier for the interview plan stage Format: uuid |
status | string | Required within parent | Status of the current application interview plan stage Known values: ACTIVE, COMPLETED, PENDING, REJECTED |
Retrieve paginated list of ATS Candidates — 200 response body — data / item / applications / item / current_application_interview_plan_stage / status: ACTIVE, COMPLETED, PENDING, REJECTED interview plan stage category type slug, default type slug, description, id, interview plan id, name, stage order
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category_type_slug | string | Required within parent | Category type slug for the interview plan stage |
default_type_slug | JSON | Optional | |
default_type_slug (anyOf 1) | string | Alternative | Default type slug for the interview plan stage |
default_type_slug (anyOf 2) | null | Alternative | Default type slug for the interview plan stage |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the interview plan stage |
description (anyOf 2) | null | Alternative | Description of the interview plan stage |
id | string | Required within parent | Unique identifier for the interview plan stage Format: uuid |
interview_plan_id | string | Required within parent | Unique identifier for the interview plan Format: uuid |
name | string | Required within parent | Name of the interview plan stage |
stage_order | JSON | Required within parent | |
stage_order (anyOf 1) | number | Alternative | Order of the stage in the interview plan Format: double |
stage_order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve paginated list of ATS Candidates — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
anonymized_at | JSON | Optional | |
anonymized_at (anyOf 1) | string | Alternative | Timestamp when the candidate was anonymized Format: date-time |
anonymized_at (anyOf 2) | null | Alternative | Timestamp when the candidate was anonymized Format: date-time |
applications | array | Optional | Applications associated with the candidate |
applications[] | Model | Each item | Expand Retrieve paginated list of ATS Candidates — 200 response body — data item applications item |
candidate_tags | JSON | Optional | |
candidate_tags (anyOf 1) | array | Alternative | Tags associated with the candidate |
candidate_tags (anyOf 1)[] | Model | Each item | Expand Retrieve paginated list of ATS Candidates — 200 response body — data item candidate tags Tags associated with the candidate item |
candidate_tags (anyOf 2) | null | Alternative | Tags associated with the candidate |
candidate_tags (anyOf 2)[] | Model | Each item | Expand Retrieve paginated list of ATS Candidates — 200 response body — data item candidate tags Tags associated with the candidate item |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | City the candidate currently lives in |
city (anyOf 2) | null | Alternative | City the candidate currently lives in |
country_code | JSON | Optional | |
country_code (anyOf 1) | string | Alternative | ISO 3166-1 alpha-2 country the candidate currently lives in |
country_code (anyOf 2) | null | Alternative | ISO 3166-1 alpha-2 country the candidate currently lives in |
created_at | string | Required within parent | Timestamp when the candidate was created Format: date-time |
email | string | Required within parent | Candidate's email address Format: email |
final_archivation_at | JSON | Optional | |
final_archivation_at (anyOf 1) | string | Alternative | Timestamp of when the candidate was finally archived Format: date-time |
final_archivation_at (anyOf 2) | null | Alternative | Timestamp of when the candidate was finally archived Format: date-time |
first_name | string | Required within parent | Candidate's first name |
id | string | Required within parent | Unique identifier for the candidate Format: uuid |
import_session_id | JSON | Optional | |
import_session_id (anyOf 1) | string | Alternative | Import session identifier |
import_session_id (anyOf 2) | null | Alternative | Import session identifier |
imported_id | JSON | Optional | |
imported_id (anyOf 1) | string | Alternative | Imported identifier |
imported_id (anyOf 2) | null | Alternative | Imported identifier |
last_name | string | Required within parent | Candidate's last name |
linkedin_profile_url | JSON | Optional | |
linkedin_profile_url (anyOf 1) | string | Alternative | URL of the candidate's LinkedIn profile |
linkedin_profile_url (anyOf 2) | null | Alternative | URL of the candidate's LinkedIn profile |
numeric_id | JSON | Required within parent | |
numeric_id (anyOf 1) | number | Alternative | Numeric identifier for the candidate Format: double |
numeric_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
origin_source_slug | JSON | Optional | |
origin_source_slug (anyOf 1) | string | Alternative | Origin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug) |
origin_source_slug (anyOf 2) | null | Alternative | Origin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug) |
phone_number | JSON | Optional | |
phone_number (anyOf 1) | string | Alternative | Candidate's phone number |
phone_number (anyOf 2) | null | Alternative | Candidate's phone number |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | URL of the candidate's profile picture |
pic_url (anyOf 2) | null | Alternative | URL of the candidate's profile picture |
source | JSON | Optional | |
source (anyOf 1) | string | Alternative | Source of the candidate |
source (anyOf 2) | null | Alternative | Source of the candidate |
total_applications_count | JSON | Optional | |
total_applications_count (anyOf 1) | number | Alternative | Total number of applications the candidate has Format: double |
total_applications_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Timestamp when the candidate was last updated Format: date-time |
Referenced models: Retrieve paginated list of ATS Candidates — 200 response body — data item applications item, Retrieve paginated list of ATS Candidates — 200 response body — data item candidate tags Tags associated with the candidate item
Retrieve paginated list of ATS Candidates — 200 response body — data item applications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Timestamp of when the application was created Format: date-time |
current_application_interview_plan_stage | JSON | Optional | |
current_application_interview_plan_stage (anyOf 1) | Model | Alternative | Expand Retrieve paginated list of ATS Candidates — 200 response body — data / item / applications / item / current_application_interview_plan_stage / status: ACTIVE, COMPLETED, PENDING, REJECTED |
current_application_interview_plan_stage (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Unique identifier for the application Format: uuid |
id (anyOf 2) | null | Alternative | Unique identifier for the application Format: uuid |
job | Model | Optional | Expand Retrieve paginated list of ATS Candidates — 200 response body — data item applications item job |
Referenced models: Retrieve paginated list of ATS Candidates — 200 response body — data item applications item job, Retrieve paginated list of ATS Candidates — 200 response body — data / item / applications / item / current_application_interview_plan_stage / status: ACTIVE, COMPLETED, PENDING, REJECTED
Retrieve paginated list of ATS Candidates — 200 response body — data item applications item job
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Unique identifier for the job Format: uuid |
title | string | Optional | Job title |
Retrieve paginated list of ATS Candidates — 200 response body — data item candidate tags Tags associated with the candidate item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
candidate_id | string | Optional | Unique identifier for the candidate Format: uuid |
id | string | Optional | Unique identifier for the candidate tag Format: uuid |
tag | JSON | Optional | |
tag (anyOf 1) | Model | Alternative | Expand Retrieve paginated list of ATS Candidates — 200 response body — data item candidate tags Tags associated with the candidate item tag id, label |
tag (anyOf 2) | null | Alternative | |
tag_id | string | Optional | Unique identifier for the tag Format: uuid |
Referenced models: Retrieve paginated list of ATS Candidates — 200 response body — data item candidate tags Tags associated with the candidate item tag id, label
Retrieve paginated list of ATS Candidates — 200 response body — data item candidate tags Tags associated with the candidate item tag id, label
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Unique identifier for the tag Format: uuid |
label | string | Optional | Label for the tag |