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.
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["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 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.talent.list_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.status | array | Optional | Default: [] |
query.status[] | string | Each item | One 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_ids | array | Optional | Default: [] |
query.requisition_ids[] | string | Each item | Format: uuid |
query.vendor_ids | array | Optional | Default: [] |
query.vendor_ids[] | string | Each item | |
query.cursor | string | Optional | Default: Maximum length: 64 |
query.limit | integer | Optional | Default: 10 Maximum: 100 Minimum: 1 |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
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 List candidates — 200 response body |
Referenced models: List candidates — 200 response body
Schemas
Section titled “Schemas”List candidates — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | The candidates on the requested page. |
data[] | Model | Each item | Expand List candidates — 200 response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | When the candidate was submitted. Format: date-time |
creation_source | string | Required within parent | How the candidate was sourced: by a talent partner or by an external provider. Known values: HACKAJOB, VMS_VENDOR |
email | JSON | Required within parent | |
email (anyOf 1) | string | Alternative | Candidate email. `null` when the talent partner did not share it. Format: email |
email (anyOf 2) | null | Alternative | Candidate email. `null` when the talent partner did not share it. Format: email |
first_name | string | Required within parent | Candidate first name. |
full_name | string | Required within parent | Candidate full name. |
id | string | Required within parent | Unique identifier of the candidate. Format: uuid |
last_name | string | Required within parent | Candidate last name. |
requisition_id | string | Required within parent | Identifier of the job request the candidate was submitted to. Format: uuid |
status | string | Required within parent | Current 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_at | string | Required within parent | When the candidate status last changed. Format: date-time |
vendor | JSON | Required within parent | Talent partner that submitted the candidate. `null` when sourced from an external provider. |
vendor (anyOf 1) | Model | Alternative | Expand List candidates — 200 response body — data item vendor id, name |
vendor (anyOf 2) | null | Alternative |
Referenced models: List candidates — 200 response body — data item vendor id, name
List candidates — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination details. |
cursor | string | Required within parent | Cursor 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_rows | JSON | Required within parent | |
total_rows (anyOf 1) | JSON | Alternative | |
total_rows (anyOf 1) (anyOf 1) | integer | Alternative | Total number of candidates matching the filters. Returned on the first page only, `null` afterwards. |
total_rows (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_rows (anyOf 2) | null | Alternative | Total number of candidates matching the filters. Returned on the first page only, `null` afterwards. |
List candidates — 200 response body — data item vendor id, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Talent partner that submitted the candidate. `null` when sourced from an external provider. |
id | string | Required within parent | Unique identifier of the talent partner. Format: uuid |
name | string | Required within parent | Talent partner name. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}