Skip to content

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

Retrieve paginated list of ATS Candidates: 200 response body, field data / item. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: 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
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

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.