Skip to content

Deel: ATS candidates schemas

13 Deel schemas with complete fields and constraints.

← ATS candidates operations · All schemas

Create ATS Candidate — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create ATS Candidate — 200 response body — data

Referenced models: Create ATS Candidate — 200 response body — data

Create ATS Candidate — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
anonymized_atJSONOptional
anonymized_at (anyOf 1)stringAlternativeTimestamp when the candidate was anonymized
Format: date-time
anonymized_at (anyOf 2)nullAlternativeTimestamp when the candidate was anonymized
Format: date-time
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 parentTimestamp when the candidate was created
Format: date-time
emailstringRequired within parentEmail address of the candidate
Format: email
final_archivation_atJSONOptional
final_archivation_at (anyOf 1)stringAlternativeTimestamp when the candidate was finally archived
Format: date-time
final_archivation_at (anyOf 2)nullAlternativeTimestamp when the candidate was finally archived
Format: date-time
first_namestringRequired within parentFirst name of the candidate
idstringRequired within parentUnique identifier for the candidate
Format: uuid
import_session_idJSONOptional
import_session_id (anyOf 1)stringAlternativeImport session identifier
import_session_id (anyOf 2)nullAlternativeImport session identifier
imported_idJSONOptional
imported_id (anyOf 1)stringAlternativeImported identifier
imported_id (anyOf 2)nullAlternativeImported identifier
last_namestringRequired within parentLast name of the candidate
linkedin_profile_urlJSONOptional
linkedin_profile_url (anyOf 1)stringAlternativeLinkedIn profile URL of the candidate
linkedin_profile_url (anyOf 2)nullAlternativeLinkedIn profile URL of the candidate
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_slugJSONOptional
origin_source_slug (anyOf 1)stringAlternativeOrigin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug)
origin_source_slug (anyOf 2)nullAlternativeOrigin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug)
phone_numberJSONOptional
phone_number (anyOf 1)stringAlternativePhone number of the candidate
phone_number (anyOf 2)nullAlternativePhone number of the candidate
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeProfile picture URL of the candidate
pic_url (anyOf 2)nullAlternativeProfile picture URL of the candidate
sourceJSONOptional
source (anyOf 1)stringAlternativeSource of the candidate
source (anyOf 2)nullAlternativeSource of the candidate
updated_atstringRequired within parentTimestamp when the candidate was last updated
Format: date-time

Create 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
emailstringRequired within parentThe candidate's email address
Format: email
first_namestringRequired within parentThe candidate's first name
last_namestringRequired within parentThe candidate's last name
linkedin_profile_urlstring or nullOptionalThe 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_numberstring or nullOptionalThe candidate's phone number
pic_urlstring or nullOptionalThe candidate's picture URL
Format: uri

Create candidate tags — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of created candidate-tag associations.
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
candidate_idstringRequired within parentUnique identifier of the candidate.
Format: uuid
created_atstringRequired within parentWhen the association was created.
Format: date-time
idstringRequired within parentUnique identifier of the candidate-tag association.
Format: uuid
tag_idstringRequired within parentUnique identifier of the tag.
Format: uuid

Retrieve paginated list of ATS Candidates — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of candidates
data[]ModelEach itemExpand Retrieve paginated list of ATS Candidates — 200 response body — data item
has_morebooleanRequired within parentIndicates if there are more items 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 candidates
Minimum: 0
total_count (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
application_idstringRequired within parentUnique identifier for the application
Format: uuid
created_atstringRequired within parentTimestamp of when the current application interview plan stage was created
Format: date-time
idstringRequired within parentUnique identifier for the current application interview plan stage
Format: uuid
interview_plan_stageJSONOptional
interview_plan_stage (anyOf 1)ModelAlternativeExpand 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)nullAlternative
interview_plan_stage_idstringRequired within parentUnique identifier for the interview plan stage
Format: uuid
statusstringRequired within parentStatus of the current application interview plan stage
Known values: ACTIVE, COMPLETED, PENDING, REJECTED

Referenced models: 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

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

FieldTypePresenceDescription and constraints
$objectRoot
category_type_slugstringRequired within parentCategory type slug for the interview plan stage
default_type_slugJSONOptional
default_type_slug (anyOf 1)stringAlternativeDefault type slug for the interview plan stage
default_type_slug (anyOf 2)nullAlternativeDefault type slug for the interview plan stage
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the interview plan stage
description (anyOf 2)nullAlternativeDescription of the interview plan stage
idstringRequired within parentUnique identifier for the interview plan stage
Format: uuid
interview_plan_idstringRequired within parentUnique identifier for the interview plan
Format: uuid
namestringRequired within parentName of the interview plan stage
stage_orderJSONRequired within parent
stage_order (anyOf 1)numberAlternativeOrder of the stage in the interview plan
Format: double
stage_order (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve paginated list of ATS Candidates — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
anonymized_atJSONOptional
anonymized_at (anyOf 1)stringAlternativeTimestamp when the candidate was anonymized
Format: date-time
anonymized_at (anyOf 2)nullAlternativeTimestamp when the candidate was anonymized
Format: date-time
applicationsarrayOptionalApplications associated with the candidate
applications[]ModelEach itemExpand Retrieve paginated list of ATS Candidates — 200 response body — data item applications item
candidate_tagsJSONOptional
candidate_tags (anyOf 1)arrayAlternativeTags associated with the candidate
candidate_tags (anyOf 1)[]ModelEach itemExpand Retrieve paginated list of ATS Candidates — 200 response body — data item candidate tags Tags associated with the candidate item
candidate_tags (anyOf 2)nullAlternativeTags associated with the candidate
candidate_tags (anyOf 2)[]ModelEach itemExpand Retrieve paginated list of ATS Candidates — 200 response body — data item candidate tags Tags associated with the candidate 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 parentTimestamp when the candidate was created
Format: date-time
emailstringRequired within parentCandidate's email address
Format: email
final_archivation_atJSONOptional
final_archivation_at (anyOf 1)stringAlternativeTimestamp of when the candidate was finally archived
Format: date-time
final_archivation_at (anyOf 2)nullAlternativeTimestamp of when the candidate was finally archived
Format: date-time
first_namestringRequired within parentCandidate's first name
idstringRequired within parentUnique identifier for the candidate
Format: uuid
import_session_idJSONOptional
import_session_id (anyOf 1)stringAlternativeImport session identifier
import_session_id (anyOf 2)nullAlternativeImport session identifier
imported_idJSONOptional
imported_id (anyOf 1)stringAlternativeImported identifier
imported_id (anyOf 2)nullAlternativeImported identifier
last_namestringRequired within parentCandidate's last name
linkedin_profile_urlJSONOptional
linkedin_profile_url (anyOf 1)stringAlternativeURL of the candidate's LinkedIn profile
linkedin_profile_url (anyOf 2)nullAlternativeURL of the candidate's LinkedIn profile
numeric_idJSONRequired within parent
numeric_id (anyOf 1)numberAlternativeNumeric identifier for the candidate
Format: double
numeric_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
origin_source_slugJSONOptional
origin_source_slug (anyOf 1)stringAlternativeOrigin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug)
origin_source_slug (anyOf 2)nullAlternativeOrigin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug)
phone_numberJSONOptional
phone_number (anyOf 1)stringAlternativeCandidate's phone number
phone_number (anyOf 2)nullAlternativeCandidate's phone number
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeURL of the candidate's profile picture
pic_url (anyOf 2)nullAlternativeURL of the candidate's profile picture
sourceJSONOptional
source (anyOf 1)stringAlternativeSource of the candidate
source (anyOf 2)nullAlternativeSource of the candidate
total_applications_countJSONOptional
total_applications_count (anyOf 1)numberAlternativeTotal number of applications the candidate has
Format: double
total_applications_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentTimestamp 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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalTimestamp of when the application was created
Format: date-time
current_application_interview_plan_stageJSONOptional
current_application_interview_plan_stage (anyOf 1)ModelAlternativeExpand 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)nullAlternative
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier for the application
Format: uuid
id (anyOf 2)nullAlternativeUnique identifier for the application
Format: uuid
jobModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalUnique identifier for the job
Format: uuid
titlestringOptionalJob title

Retrieve paginated list of ATS Candidates — 200 response body — data item candidate tags Tags associated with the candidate item

FieldTypePresenceDescription and constraints
$objectRoot
candidate_idstringOptionalUnique identifier for the candidate
Format: uuid
idstringOptionalUnique identifier for the candidate tag
Format: uuid
tagJSONOptional
tag (anyOf 1)ModelAlternativeExpand 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)nullAlternative
tag_idstringOptionalUnique 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalUnique identifier for the tag
Format: uuid
labelstringOptionalLabel for the tag

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.