Deel: List onboarding employees
Deel onboarding.listOnboardingEmployees: arguments, response, policy and SDK examples.
← Onboarding operations · Get started
Operation deel.onboarding_listonboardingemployees_v2026_01_01
Provider route: GET /onboarding/tracker. 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["onboarding"]["listOnboardingEmployees"]>[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.onboarding.listOnboardingEmployees(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.onboarding.list_onboarding_employees(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.search | string | Optional | Maximum length: 255 |
query.contractOid | array | Optional | Default: [] |
query.contractOid[] | string | Each item | |
query.hiringTypes | array | Optional | Default: [] |
query.hiringTypes[] | string | Each item | Hiring type (e.g., contractor, eor) One of: contractor, direct_employee, hris_direct_employee, hris_direct_contractor, eor, peo, person_without_contract |
query.progressStatuses | array | Optional | Default: [] |
query.progressStatuses[] | string | Each item | Progress status of the contract One of: ONBOARDING_AT_RISK, ONBOARDING_OVERDUE, INVITED, ONBOARDING, READY_TO_START, INACTIVE, PENDING_INVITE, ACTIVE, DRAFT, OFFBOARDING, QUOTE_REQUIRES_CHANGES, IN_REVIEW, IN_OFFER_STAGE |
query.countries | array | Optional | Default: [] |
query.countries[] | string | Each item | |
query.teams | array | Optional | Default: [] |
query.teams[] | string | Each item | |
query.legalEntities | array | Optional | Default: [] |
query.legalEntities[] | string | Each item | |
query.hrisDirectManagers | array | Optional | Default: [] |
query.hrisDirectManagers[] | string | Each item | Format: uuid |
query.fromDate | string | Optional | Format: date-time |
query.toDate | string | Optional | Format: date-time |
query.actions | array | Optional | Default: [] |
query.actions[] | string | Each item | One of: CLIENT_ACTION_REQUIRED, CLIENT_ACTION_NOT_REQUIRED |
query.lifecycleStatuses | array | Optional | Default: [] |
query.lifecycleStatuses[] | string | Each item | Lifecycle status of the onboarding One of: DRAFT, IN_REVIEW, QUOTE_REQUIRES_CHANGES, PENDING_INVITE, INVITED, ONBOARDING, ONBOARDING_AT_RISK, ONBOARDING_OVERDUE, OFFBOARDING, ONBOARDED |
query.waitingOnParties | array | Optional | Default: [] |
query.waitingOnParties[] | string | Each item | Party the onboarding is waiting on One of: WORKER, CLIENT, DEEL |
query.card | string | Optional | One of: ACTION_REQUIRED, OVERDUE, WITH_DEEL_FOR_REVIEW, READY_TO_START, STARTING_THIS_WEEK |
query.weekFromDate | string | Optional | Format: date |
query.weekToDate | string | Optional | Format: date |
query.limit | integer | Optional | Default: 20 Maximum: 200 Minimum: 1 |
query.sort_by | string | Optional | Default: progressStatusWeight One of: progressStatusWeight |
query.sort_order | string | Optional | Default: ASC One of: ASC, DESC |
query.cursor | string | Optional | |
query.include_overview | boolean | Optional | Default: false |
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 onboarding employees — 200 response body |
Referenced models: List onboarding employees — 200 response body
Schemas
Section titled “Schemas”36 more schemas are linked from the tables above, on the schema pages.
List onboarding employees — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand List onboarding employees — 200 response body — data item |
page | Model | Optional | Expand List onboarding employees — 200 response body — page |
Referenced models: List onboarding employees — 200 response body — data item, List onboarding employees — 200 response body — page
List onboarding employees — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
app_experience | Model | Optional | Expand List onboarding employees — 200 response body — data item app experience The app experience of the employee |
can_send_invitation | boolean | Optional | Only for a Global Payroll direct employee, when the organization sends app invitations. Whether the invitation to the app can be sent: the employee has app access and has not signed up yet |
contract | Model | Optional | Expand List onboarding employees — 200 response body — data item contract The contract associated with the onboarding |
contracts | array | Optional | Every contract of the worker the caller can see, the main one first, so each row of the worker lists the same contracts. A worker has one row per worker type, so the main contract can belong to another row: compare `contract_oid` with `contract.id`. Empty for a draft quote |
contracts[] | Model | Each item | Expand List onboarding employees — 200 response body — data item contracts item |
country | Model | Optional | Expand List onboarding employees — 200 response body — data item country The country of the contract |
hiring_type | string | Optional | The type of hiring (e.g., contractor) |
hris_profile | Model | Optional | Expand List onboarding employees — 200 response body — data item hris profile The profile associated with the onboarding |
invitation_sent | boolean | Optional | Only for a Global Payroll direct employee, when the organization sends app invitations. Whether the invitation to the app was sent and the employee has not signed up yet |
name | string | Optional | The name associated with the onboarding |
overview | JSON | Optional | Only with `include_overview`. The onboarding overview of the contract, as `GET /onboarding/tracker/{tracker_id}` returns it in `data` |
overview (anyOf 1) | Model | Alternative | Expand List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary |
overview (anyOf 2) | null | Alternative | |
pending_steps | string | Optional | Only with `include_overview`. The labels of the checklist steps not done yet, comma separated |
profile | Model | Optional | Expand List onboarding employees — 200 response body — data item profile Only when the worker has an avatar |
progress | Model | Optional | Expand List onboarding employees — 200 response body — data item progress The progress state of the onboarding |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The start date of the contract Format: date |
start_date (anyOf 2) | null | Alternative | The start date of the contract Format: date |
unique_id | string | Optional | A unique identifier for the tracker |
worker | Model | Optional | Expand List onboarding employees — 200 response body — data item worker The worker being onboarded |
Referenced models: List onboarding employees — 200 response body — data item profile, List onboarding employees — 200 response body — data item app experience, List onboarding employees — 200 response body — data item contract, List onboarding employees — 200 response body — data item contracts item, List onboarding employees — 200 response body — data item country, List onboarding employees — 200 response body — data item hris profile, List onboarding employees — 200 response body — data item overview actions, app experience, banner, banners, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary, List onboarding employees — 200 response body — data item progress, List onboarding employees — 200 response body — data item worker
List onboarding employees — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cursor | JSON | Optional | |
cursor (anyOf 1) | string | Alternative | Cursor for pagination |
cursor (anyOf 2) | null | Alternative | Cursor for pagination |
total_rows | JSON | Optional | |
total_rows (anyOf 1) | integer | Alternative | Total number of onboardings matching the filters. Stays the same across every page of a cursor walk. |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List onboarding employees — 200 response body — data item profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Only when the worker has an avatar |
pic_url | string | Optional | The avatar URL of the worker, the same value as `worker.avatar_url` |
List onboarding employees — 200 response body — data item app experience
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The app experience of the employee |
experience_type | JSON | Optional | The app experience the employee is given, when there is a specific one |
experience_type (anyOf 1) | string | Alternative | The app experience the employee is given, when there is a specific one Known values: LIGHTWEIGHT |
experience_type (anyOf 2) | null | Alternative | |
is_minimal_requirements | boolean | Optional | Indicates if the employee meets minimal requirements |
List onboarding employees — 200 response body — data item contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The contract associated with the onboarding |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | string | Alternative | The effective date of the contract. Null for a person without a contract Format: date |
effective_date (anyOf 2) | null | Alternative | The effective date of the contract. Null for a person without a contract Format: date |
eor | Model | Optional | Expand List onboarding employees — 200 response body — data item contract eor Only for an EOR contract |
global_payroll | Model | Optional | Expand List onboarding employees — 200 response body — data item contract global payroll Only for a Global Payroll direct employee |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The unique identifier for the contract. Null for a person without a contract |
id (anyOf 2) | null | Alternative | The unique identifier for the contract. Null for a person without a contract |
is_pwac | boolean | Optional | Whether the worker is a person without a contract |
offer_letter_id | string | Optional | Only for an EOR contract with an offer letter. The identifier of the offer letter Format: uuid |
Referenced models: List onboarding employees — 200 response body — data item contract global payroll, List onboarding employees — 200 response body — data item contract eor
List onboarding employees — 200 response body — data item country
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The country of the contract |
code | JSON | Optional | |
code (anyOf 1) | string | Alternative | ISO 3166-1 alpha-2 country code |
code (anyOf 2) | null | Alternative | ISO 3166-1 alpha-2 country code |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The country display name |
name (anyOf 2) | null | Alternative | The country display name |
List onboarding employees — 200 response body — data item hris profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The profile associated with the onboarding |
oid | string | Optional | The unique identifier for the HRIS profile |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | The work email of the employee |
work_email (anyOf 2) | null | Alternative | The work email of the employee |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.onboarding_listonboardingemployees_v2026_01_01. Catalog operation: onboarding_listonboardingemployees_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: ["contracts:read", "people:read"]
Pinned headers: {"X-Version": "2026-01-01"}