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.
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["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 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_candidates.retrieve_paginated_list_of_ats_candidates(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.cursor | string | Optional | |
query.limit | integer | Optional | Default: 20 Maximum: 100 Minimum: 1 |
query.search | string | Optional | |
query.job_ids | array | Optional | |
query.job_ids[] | string | Each item | Format: uuid |
query.department_ids | array | Optional | |
query.department_ids[] | string | Each item | Format: uuid |
query.tag_ids | array | Optional | |
query.tag_ids[] | string | Each item | Format: uuid |
query.current_stage_category_type_slugs | array | Optional | |
query.current_stage_category_type_slugs[] | string | Each item | |
query.current_stage_default_type_slugs | array | Optional | |
query.current_stage_default_type_slugs[] | string | Each item | |
query.updated_after | string | Optional | Format: date-time |
query.source_slugs | array | Optional | |
query.source_slugs[] | string | Each item | Maximum length: 50 |
query.team_ids | array | Optional | |
query.team_ids[] | string | Each item | Format: uuid |
query.locations | array | Optional | |
query.locations[] | string | Each item | Maximum length: 153 |
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 paginated list of ATS Candidates — 200 response body |
Referenced models: Retrieve paginated list of ATS Candidates — 200 response body
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
Retrieve paginated list of ATS Candidates — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of candidates |
data[] | Model | Each item | Expand Retrieve paginated list of ATS Candidates — 200 response body — data item |
has_more | boolean | Required within parent | Indicates if there are more items to fetch |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for the next page of results |
next_cursor (anyOf 2) | null | Alternative | Cursor for the next page of results |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of candidates Minimum: 0 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
anonymized_at | JSON | Optional | |
anonymized_at (anyOf 1) | string | Alternative | Timestamp when the candidate was anonymized Format: date-time |
anonymized_at (anyOf 2) | null | Alternative | Timestamp when the candidate was anonymized Format: date-time |
applications | array | Optional | Applications associated with the candidate |
applications[] | Model | Each item | Expand Retrieve paginated list of ATS Candidates — 200 response body — data item applications item |
candidate_tags | JSON | Optional | |
candidate_tags (anyOf 1) | array | Alternative | Tags associated with the candidate |
candidate_tags (anyOf 1)[] | Model | Each item | Expand Retrieve paginated list of ATS Candidates — 200 response body — data item candidate tags Tags associated with the candidate item |
candidate_tags (anyOf 2) | null | Alternative | Tags associated with the candidate |
candidate_tags (anyOf 2)[] | Model | Each item | Expand Retrieve paginated list of ATS Candidates — 200 response body — data item candidate tags Tags associated with the candidate 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 | Timestamp 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 | Timestamp of when the candidate was finally archived Format: date-time |
final_archivation_at (anyOf 2) | null | Alternative | Timestamp of when the candidate was finally archived Format: date-time |
first_name | string | Required within parent | Candidate's first name |
id | string | Required within parent | Unique identifier for the candidate Format: uuid |
import_session_id | JSON | Optional | |
import_session_id (anyOf 1) | string | Alternative | Import session identifier |
import_session_id (anyOf 2) | null | Alternative | Import session identifier |
imported_id | JSON | Optional | |
imported_id (anyOf 1) | string | Alternative | Imported identifier |
imported_id (anyOf 2) | null | Alternative | Imported identifier |
last_name | string | Required within parent | Candidate's last name |
linkedin_profile_url | JSON | Optional | |
linkedin_profile_url (anyOf 1) | string | Alternative | URL of the candidate's LinkedIn profile |
linkedin_profile_url (anyOf 2) | null | Alternative | URL of the candidate's LinkedIn profile |
numeric_id | JSON | Required within parent | |
numeric_id (anyOf 1) | number | Alternative | Numeric identifier for the candidate Format: double |
numeric_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
origin_source_slug | JSON | Optional | |
origin_source_slug (anyOf 1) | string | Alternative | Origin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug) |
origin_source_slug (anyOf 2) | null | Alternative | Origin source slug of the candidate (e.g. sourced_internally, external_career_page or a custom source slug) |
phone_number | JSON | Optional | |
phone_number (anyOf 1) | string | Alternative | Candidate's phone number |
phone_number (anyOf 2) | null | Alternative | Candidate's phone number |
pic_url | JSON | Optional | |
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 |
source | JSON | Optional | |
source (anyOf 1) | string | Alternative | Source of the candidate |
source (anyOf 2) | null | Alternative | Source of the candidate |
total_applications_count | JSON | Optional | |
total_applications_count (anyOf 1) | number | Alternative | Total number of applications the candidate has Format: double |
total_applications_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updated_at | string | Required within parent | Timestamp 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Timestamp of when the application was created Format: date-time |
current_application_interview_plan_stage | JSON | Optional | |
current_application_interview_plan_stage (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Unique identifier for the application Format: uuid |
id (anyOf 2) | null | Alternative | Unique identifier for the application Format: uuid |
job | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
candidate_id | string | Optional | Unique identifier for the candidate Format: uuid |
id | string | Optional | Unique identifier for the candidate tag Format: uuid |
tag | JSON | Optional | |
tag (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
tag_id | string | Optional | Unique 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Unique identifier for the job Format: uuid |
title | string | Optional | Job title |
Retrieve paginated list of ATS Candidates — 200 response body — data item candidate tags Tags associated with the candidate item tag id, label
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Unique identifier for the tag Format: uuid |
label | string | Optional | Label for the tag |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}