Skip to content

Deel: List candidates

Deel talent.listCandidates: arguments, response, policy and SDK examples.

← Talent operations · Get started

Operation deel.talent_listcandidates_v2026_10_29

Provider route: GET /talent/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["talent"]["listCandidates"]>[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.talent.listCandidates(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.talent.list_candidates(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.statusarrayOptionalDefault: []
query.status[]stringEach itemOne of: CANCELLED_BY_HIRER, CANCELLED_BY_VENDOR, CONTRACT_CREATED, INITIAL_SCREENING_REJECTED, INTERVIEW_REJECTED, OFFER_ACCEPTED, OFFER_REJECTED, OFFER_SENT, PENDING_INITIAL_SCREENING, PENDING_INTERVIEW, WAITING_FOR_OFFER
query.requisition_idsarrayOptionalDefault: []
query.requisition_ids[]stringEach itemFormat: uuid
query.vendor_idsarrayOptionalDefault: []
query.vendor_ids[]stringEach item
query.cursorstringOptionalDefault:
Maximum length: 64
query.limitintegerOptionalDefault: 10
Maximum: 100
Minimum: 1
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List candidates — 200 response body

Referenced models: List candidates — 200 response body

List candidates — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentThe candidates on the requested page.
data[]ModelEach itemExpand List candidates — 200 response body — data item
pageModelRequired within parentExpand List candidates — 200 response body — page
Pagination details.

Referenced models: List candidates — 200 response body — data item, List candidates — 200 response body — page

List candidates — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentWhen the candidate was submitted.
Format: date-time
creation_sourcestringRequired within parentHow the candidate was sourced: by a talent partner or by an external provider.
Known values: HACKAJOB, VMS_VENDOR
emailJSONRequired within parent
email (anyOf 1)stringAlternativeCandidate email. `null` when the talent partner did not share it.
Format: email
email (anyOf 2)nullAlternativeCandidate email. `null` when the talent partner did not share it.
Format: email
first_namestringRequired within parentCandidate first name.
full_namestringRequired within parentCandidate full name.
idstringRequired within parentUnique identifier of the candidate.
Format: uuid
last_namestringRequired within parentCandidate last name.
requisition_idstringRequired within parentIdentifier of the job request the candidate was submitted to.
Format: uuid
statusstringRequired within parentCurrent pipeline status of the candidate.
Known values: CANCELLED_BY_HIRER, CANCELLED_BY_VENDOR, CONTRACT_CREATED, INITIAL_SCREENING_REJECTED, INTERVIEW_REJECTED, OFFER_ACCEPTED, OFFER_REJECTED, OFFER_SENT, PENDING_INITIAL_SCREENING, PENDING_INTERVIEW, WAITING_FOR_OFFER
status_updated_atstringRequired within parentWhen the candidate status last changed.
Format: date-time
vendorJSONRequired within parentTalent partner that submitted the candidate. `null` when sourced from an external provider.
vendor (anyOf 1)ModelAlternativeExpand List candidates — 200 response body — data item vendor id, name
vendor (anyOf 2)nullAlternative

Referenced models: List candidates — 200 response body — data item vendor id, name

List candidates — 200 response body — page
FieldTypePresenceDescription and constraints
$objectRootPagination details.
cursorstringRequired within parentCursor to pass to the next request. Still set on the last page; the end of the list is reached when a request returns an empty `data` and an empty cursor.
total_rowsJSONRequired within parent
total_rows (anyOf 1)JSONAlternative
total_rows (anyOf 1) (anyOf 1)integerAlternativeTotal number of candidates matching the filters. Returned on the first page only, `null` afterwards.
total_rows (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_rows (anyOf 2)nullAlternativeTotal number of candidates matching the filters. Returned on the first page only, `null` afterwards.
List candidates — 200 response body — data item vendor id, name
FieldTypePresenceDescription and constraints
$objectRootTalent partner that submitted the candidate. `null` when sourced from an external provider.
idstringRequired within parentUnique identifier of the talent partner.
Format: uuid
namestringRequired within parentTalent partner name.

SDK function policy ID: deel.talent_listcandidates_v2026_10_29. Catalog operation: talent_listcandidates_v2026_10_29. 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: ["talents:read"]

Pinned headers: {"X-Version": "2026-10-29"}

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.