Deel: Retrieve an ATS candidate — 200 response body — data
Retrieve an ATS candidate: 200 response body, field data. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Retrieve an ATS candidate — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Candidate detail. |
anonymized_at | JSON | Optional | |
anonymized_at (anyOf 1) | string | Alternative | When the candidate data was anonymized. Format: date-time |
anonymized_at (anyOf 2) | null | Alternative | When the candidate data was anonymized. Format: date-time |
applications | array | Required within parent | Applications of the candidate the authenticated user may see, newest first. |
applications[] | Model | Each item | Expand Retrieve an ATS candidate — 200 response body — data applications item |
attachments | array | Required within parent | Documents attached to the candidate, newest first. |
attachments[] | Model | Each item | Expand Retrieve an ATS candidate — 200 response body — data attachments item |
candidate_tags | array | Required within parent | Tags applied to the candidate. |
candidate_tags[] | Model | Each item | Expand Retrieve an ATS candidate — 200 response body — data candidate tags 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 | 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 | When the candidate was finally archived. Format: date-time |
final_archivation_at (anyOf 2) | null | Alternative | When the candidate was finally archived. Format: date-time |
first_name | string | Required within parent | Candidate’s first name. |
id | string | Required within parent | Candidate identifier. Format: uuid |
import_session_id | JSON | Optional | |
import_session_id (anyOf 1) | string | Alternative | Bulk import session the candidate came from. |
import_session_id (anyOf 2) | null | Alternative | Bulk import session the candidate came from. |
imported_id | JSON | Optional | |
imported_id (anyOf 1) | string | Alternative | External identifier from the import source. |
imported_id (anyOf 2) | null | Alternative | External identifier from the import source. |
last_name | string | Required within parent | Candidate’s last name. |
linkedin_profile_url | JSON | Required within parent | |
linkedin_profile_url (anyOf 1) | string | Alternative | Candidate’s LinkedIn profile URL. |
linkedin_profile_url (anyOf 2) | null | Alternative | Candidate’s LinkedIn profile URL. |
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 | Required within parent | |
origin_source_slug (anyOf 1) | string | Alternative | How the candidate first entered the ATS. |
origin_source_slug (anyOf 2) | null | Alternative | How the candidate first entered the ATS. |
phone_number | JSON | Required within parent | |
phone_number (anyOf 1) | string | Alternative | Candidate’s phone number. |
phone_number (anyOf 2) | null | Alternative | Candidate’s phone number. |
pic_url | JSON | Required within parent | |
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. |
referred_by_hris_organization_user_id | JSON | Optional | |
referred_by_hris_organization_user_id (anyOf 1) | string | Alternative | Employee who referred the candidate. Format: uuid |
referred_by_hris_organization_user_id (anyOf 2) | null | Alternative | Employee who referred the candidate. Format: uuid |
updated_at | string | Required within parent | When the candidate was last updated. Format: date-time |
Referenced models: Retrieve an ATS candidate — 200 response body — data candidate tags item, Retrieve an ATS candidate — 200 response body — data applications item, Retrieve an ATS candidate — 200 response body — data attachments item