Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.candidate_idstringRequired within parentFormat: uuid

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve an ATS candidate — 200 response body

Referenced models: Retrieve an ATS candidate — 200 response body

3 more schemas are linked from the tables above, on the schema pages.

Retrieve an ATS candidate — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootCandidate detail.
anonymized_atJSONOptional
anonymized_at (anyOf 1)stringAlternativeWhen the candidate data was anonymized.
Format: date-time
anonymized_at (anyOf 2)nullAlternativeWhen the candidate data was anonymized.
Format: date-time
applicationsarrayRequired within parentApplications of the candidate the authenticated user may see, newest first.
applications[]ModelEach itemExpand Retrieve an ATS candidate — 200 response body — data applications item
attachmentsarrayRequired within parentDocuments attached to the candidate, newest first.
attachments[]ModelEach itemExpand Retrieve an ATS candidate — 200 response body — data attachments item
candidate_tagsarrayRequired within parentTags applied to the candidate.
candidate_tags[]ModelEach itemExpand Retrieve an ATS candidate — 200 response body — data candidate tags 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 parentWhen the candidate was created.
Format: date-time
emailstringRequired within parentCandidate's email address.
Format: email
final_archivation_atJSONOptional
final_archivation_at (anyOf 1)stringAlternativeWhen the candidate was finally archived.
Format: date-time
final_archivation_at (anyOf 2)nullAlternativeWhen the candidate was finally archived.
Format: date-time
first_namestringRequired within parentCandidate's first name.
idstringRequired within parentCandidate identifier.
Format: uuid
import_session_idJSONOptional
import_session_id (anyOf 1)stringAlternativeBulk import session the candidate came from.
import_session_id (anyOf 2)nullAlternativeBulk import session the candidate came from.
imported_idJSONOptional
imported_id (anyOf 1)stringAlternativeExternal identifier from the import source.
imported_id (anyOf 2)nullAlternativeExternal identifier from the import source.
last_namestringRequired within parentCandidate's last name.
linkedin_profile_urlJSONRequired within parent
linkedin_profile_url (anyOf 1)stringAlternativeCandidate's LinkedIn profile URL.
linkedin_profile_url (anyOf 2)nullAlternativeCandidate's LinkedIn profile URL.
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_slugJSONRequired within parent
origin_source_slug (anyOf 1)stringAlternativeHow the candidate first entered the ATS.
origin_source_slug (anyOf 2)nullAlternativeHow the candidate first entered the ATS.
phone_numberJSONRequired within parent
phone_number (anyOf 1)stringAlternativeCandidate's phone number.
phone_number (anyOf 2)nullAlternativeCandidate's phone number.
pic_urlJSONRequired within parent
pic_url (anyOf 1)stringAlternativeURL of the candidate's profile picture.
pic_url (anyOf 2)nullAlternativeURL of the candidate's profile picture.
referred_by_hris_organization_user_idJSONOptional
referred_by_hris_organization_user_id (anyOf 1)stringAlternativeEmployee who referred the candidate.
Format: uuid
referred_by_hris_organization_user_id (anyOf 2)nullAlternativeEmployee who referred the candidate.
Format: uuid
updated_atstringRequired within parentWhen 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
FieldTypePresenceDescription and constraints
$objectRootA tag applied to the candidate.
idstringRequired within parentCandidate tag record identifier.
Format: uuid
tagModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootAn application of the candidate.
archivation_reason_idJSONRequired within parent
archivation_reason_id (anyOf 1)stringAlternativeReason the application was archived; null unless archived.
Format: uuid
archivation_reason_id (anyOf 2)nullAlternativeReason the application was archived; null unless archived.
Format: uuid
created_atstringRequired within parentWhen the application was created.
Format: date-time
current_application_interview_plan_stageJSONRequired within parentWhere the application is now.
current_application_interview_plan_stage (anyOf 1)ModelAlternativeExpand 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)nullAlternative
hired_atJSONRequired within parent
hired_at (anyOf 1)stringAlternativeWhen the application reached the hired stage; null otherwise.
Format: date-time
hired_at (anyOf 2)nullAlternativeWhen the application reached the hired stage; null otherwise.
Format: date-time
idstringRequired within parentApplication identifier.
Format: uuid
jobModelRequired within parentExpand Retrieve an ATS candidate — 200 response body — data applications item job
Job of the application.
moved_to_current_stage_atstringRequired within parentWhen the application entered its current stage.
Format: date-time
numeric_idJSONRequired within parent
numeric_id (anyOf 1)integerAlternativeApplication numeric identifier.
numeric_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentWhen 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
FieldTypePresenceDescription and constraints
$objectRootA document attached to the candidate.
ai_summaryJSONRequired within parent
ai_summary (anyOf 1)stringAlternativeAI-generated summary of the document (CVs only); null when not yet generated.
ai_summary (anyOf 2)nullAlternativeAI-generated summary of the document (CVs only); null when not yet generated.
attachment_type_slugstringRequired within parentKind of attachment.
Known values: CV, LOGO, OFFER_LETTER, OTHER
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeWhen the file was attached.
Format: date-time
created_at (anyOf 2)nullAlternativeWhen the file was attached.
Format: date-time
file_content_typestringRequired within parentMIME type of the file.
file_namestringRequired within parentOriginal file name.
idstringRequired within parentAttachment identifier (use GET /rest/ats/attachments for a download URL).
Format: uuid
Retrieve an ATS candidate — 200 response body — data candidate tags item tag
FieldTypePresenceDescription and constraints
$objectRootThe tag.
idstringRequired within parentTag identifier.
Format: uuid
labelstringRequired within parentTag label.

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"}

Official provider source

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.