Deel: Retrieve paginated list of ATS Candidates

← ats_candidates operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.atscandidates_retrievepaginatedlistofatscandidates_v2026_01_01

Provider route: GET /ats/candidates. Alter supplies the connection’s credentials and routing.

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 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()

Input

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

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

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

Official provider source