Deel: Retrieve an ATS candidate
Deel ats.retrieveAtsCandidate: arguments, response, policy and SDK examples.
← ATS operations · Get started
Operation deel.ats_retrieveatscandidate_v2026_09_18
Provider route: GET /ats/candidates/{candidate_id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["ats"]["retrieveAtsCandidate"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.ats.retrieveAtsCandidate(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.ats.retrieve_ats_candidate(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.candidate_id | string | Required within parent | Format: uuid |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve an ATS candidate — 200 response body |
Referenced models: Retrieve an ATS candidate — 200 response body
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
Retrieve an ATS candidate — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve an ATS candidate — 200 response body — data Candidate detail. |
Referenced models: Retrieve an ATS candidate — 200 response body — data
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
Retrieve an ATS candidate — 200 response body — data candidate tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A tag applied to the candidate. |
id | string | Required within parent | Candidate tag record identifier. Format: uuid |
tag | Model | Required within parent | Expand Retrieve an ATS candidate — 200 response body — data candidate tags item tag The tag. |
Referenced models: Retrieve an ATS candidate — 200 response body — data candidate tags item tag
Retrieve an ATS candidate — 200 response body — data applications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An application of the candidate. |
archivation_reason_id | JSON | Required within parent | |
archivation_reason_id (anyOf 1) | string | Alternative | Reason the application was archived; null unless archived. Format: uuid |
archivation_reason_id (anyOf 2) | null | Alternative | Reason the application was archived; null unless archived. Format: uuid |
created_at | string | Required within parent | When the application was created. Format: date-time |
current_application_interview_plan_stage | JSON | Required within parent | Where the application is now. |
current_application_interview_plan_stage (anyOf 1) | Model | Alternative | Expand Retrieve an ATS candidate — 200 response body — data applications item current application interview plan stage Where the application is now |
current_application_interview_plan_stage (anyOf 2) | null | Alternative | |
hired_at | JSON | Required within parent | |
hired_at (anyOf 1) | string | Alternative | When the application reached the hired stage; null otherwise. Format: date-time |
hired_at (anyOf 2) | null | Alternative | When the application reached the hired stage; null otherwise. Format: date-time |
id | string | Required within parent | Application identifier. Format: uuid |
job | Model | Required within parent | Expand Retrieve an ATS candidate — 200 response body — data applications item job Job of the application. |
moved_to_current_stage_at | string | Required within parent | When the application entered its current stage. Format: date-time |
numeric_id | JSON | Required within parent | |
numeric_id (anyOf 1) | integer | Alternative | Application numeric identifier. |
numeric_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | When the application was last updated. Format: date-time |
Referenced models: Retrieve an ATS candidate — 200 response body — data applications item job, Retrieve an ATS candidate — 200 response body — data applications item current application interview plan stage Where the application is now
Retrieve an ATS candidate — 200 response body — data attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A document attached to the candidate. |
ai_summary | JSON | Required within parent | |
ai_summary (anyOf 1) | string | Alternative | AI-generated summary of the document (CVs only); null when not yet generated. |
ai_summary (anyOf 2) | null | Alternative | AI-generated summary of the document (CVs only); null when not yet generated. |
attachment_type_slug | string | Required within parent | Kind of attachment. Known values: CV, LOGO, OFFER_LETTER, OTHER |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | When the file was attached. Format: date-time |
created_at (anyOf 2) | null | Alternative | When the file was attached. Format: date-time |
file_content_type | string | Required within parent | MIME type of the file. |
file_name | string | Required within parent | Original file name. |
id | string | Required within parent | Attachment identifier (use GET /rest/ats/attachments for a download URL). Format: uuid |
Retrieve an ATS candidate — 200 response body — data candidate tags item tag
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The tag. |
id | string | Required within parent | Tag identifier. Format: uuid |
label | string | Required within parent | Tag label. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.ats_retrieveatscandidate_v2026_09_18. Catalog operation: ats_retrieveatscandidate_v2026_09_18. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["ats:read", "worker:read"]
Pinned headers: {"X-Version": "2026-09-18"}