Skip to content

Deel: Retrieve paginated list of ATS Candidates

Deel atsCandidates.retrievePaginatedListOfAtsCandidates: arguments, response, policy and SDK examples.

← ATS candidates operations · Get started

Operation deel.atscandidates_retrievepaginatedlistofatscandidates_v2026_01_01

Provider route: GET /ats/candidates. 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["atsCandidates"]["retrievePaginatedListOfAtsCandidates"]>[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.atsCandidates.retrievePaginatedListOfAtsCandidates(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_candidates.retrieve_paginated_list_of_ats_candidates(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.cursorstringOptional
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1
query.searchstringOptional
query.job_idsarrayOptional
query.job_ids[]stringEach itemFormat: uuid
query.department_idsarrayOptional
query.department_ids[]stringEach itemFormat: uuid
query.tag_idsarrayOptional
query.tag_ids[]stringEach itemFormat: uuid
query.current_stage_category_type_slugsarrayOptional
query.current_stage_category_type_slugs[]stringEach item
query.current_stage_default_type_slugsarrayOptional
query.current_stage_default_type_slugs[]stringEach item
query.updated_afterstringOptionalFormat: date-time
query.source_slugsarrayOptional
query.source_slugs[]stringEach itemMaximum length: 50
query.team_idsarrayOptional
query.team_ids[]stringEach itemFormat: uuid
query.locationsarrayOptional
query.locations[]stringEach itemMaximum length: 153

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve paginated list of ATS Candidates — 200 response body

Referenced models: Retrieve paginated list of ATS Candidates — 200 response body

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

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
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 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 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 tag id, label
FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalUnique identifier for the tag
Format: uuid
labelstringOptionalLabel for the tag

SDK function policy ID: deel.atscandidates_retrievepaginatedlistofatscandidates_v2026_01_01. Catalog operation: atscandidates_retrievepaginatedlistofatscandidates_v2026_01_01. 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"]

Pinned headers: {"X-Version": "2026-01-01"}

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.