Skip to content

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.

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 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.onboarding.list_onboarding_employees(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.searchstringOptionalMaximum length: 255
query.contractOidarrayOptionalDefault: []
query.contractOid[]stringEach item
query.hiringTypesarrayOptionalDefault: []
query.hiringTypes[]stringEach itemHiring type (e.g., contractor, eor)
One of: contractor, direct_employee, hris_direct_employee, hris_direct_contractor, eor, peo, person_without_contract
query.progressStatusesarrayOptionalDefault: []
query.progressStatuses[]stringEach itemProgress 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.countriesarrayOptionalDefault: []
query.countries[]stringEach item
query.teamsarrayOptionalDefault: []
query.teams[]stringEach item
query.legalEntitiesarrayOptionalDefault: []
query.legalEntities[]stringEach item
query.hrisDirectManagersarrayOptionalDefault: []
query.hrisDirectManagers[]stringEach itemFormat: uuid
query.fromDatestringOptionalFormat: date-time
query.toDatestringOptionalFormat: date-time
query.actionsarrayOptionalDefault: []
query.actions[]stringEach itemOne of: CLIENT_ACTION_REQUIRED, CLIENT_ACTION_NOT_REQUIRED
query.lifecycleStatusesarrayOptionalDefault: []
query.lifecycleStatuses[]stringEach itemLifecycle status of the onboarding
One of: DRAFT, IN_REVIEW, QUOTE_REQUIRES_CHANGES, PENDING_INVITE, INVITED, ONBOARDING, ONBOARDING_AT_RISK, ONBOARDING_OVERDUE, OFFBOARDING, ONBOARDED
query.waitingOnPartiesarrayOptionalDefault: []
query.waitingOnParties[]stringEach itemParty the onboarding is waiting on
One of: WORKER, CLIENT, DEEL
query.cardstringOptionalOne of: ACTION_REQUIRED, OVERDUE, WITH_DEEL_FOR_REVIEW, READY_TO_START, STARTING_THIS_WEEK
query.weekFromDatestringOptionalFormat: date
query.weekToDatestringOptionalFormat: date
query.limitintegerOptionalDefault: 20
Maximum: 200
Minimum: 1
query.sort_bystringOptionalDefault: progressStatusWeight
One of: progressStatusWeight
query.sort_orderstringOptionalDefault: ASC
One of: ASC, DESC
query.cursorstringOptional
query.include_overviewbooleanOptionalDefault: false

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List onboarding employees — 200 response body

Referenced models: List onboarding employees — 200 response body

36 more schemas are linked from the tables above, on the schema pages.

List onboarding employees — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand List onboarding employees — 200 response body — data item
pageModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
app_experienceModelOptionalExpand List onboarding employees — 200 response body — data item app experience
The app experience of the employee
can_send_invitationbooleanOptionalOnly 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
contractModelOptionalExpand List onboarding employees — 200 response body — data item contract
The contract associated with the onboarding
contractsarrayOptionalEvery 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[]ModelEach itemExpand List onboarding employees — 200 response body — data item contracts item
countryModelOptionalExpand List onboarding employees — 200 response body — data item country
The country of the contract
hiring_typestringOptionalThe type of hiring (e.g., contractor)
hris_profileModelOptionalExpand List onboarding employees — 200 response body — data item hris profile
The profile associated with the onboarding
invitation_sentbooleanOptionalOnly 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
namestringOptionalThe name associated with the onboarding
overviewJSONOptionalOnly with `include_overview`. The onboarding overview of the contract, as `GET /onboarding/tracker/{tracker_id}` returns it in `data`
overview (anyOf 1)ModelAlternativeExpand 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)nullAlternative
pending_stepsstringOptionalOnly with `include_overview`. The labels of the checklist steps not done yet, comma separated
profileModelOptionalExpand List onboarding employees — 200 response body — data item profile
Only when the worker has an avatar
progressModelOptionalExpand List onboarding employees — 200 response body — data item progress
The progress state of the onboarding
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeThe start date of the contract
Format: date
start_date (anyOf 2)nullAlternativeThe start date of the contract
Format: date
unique_idstringOptionalA unique identifier for the tracker
workerModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONOptional
cursor (anyOf 1)stringAlternativeCursor for pagination
cursor (anyOf 2)nullAlternativeCursor for pagination
total_rowsJSONOptional
total_rows (anyOf 1)integerAlternativeTotal number of onboardings matching the filters. Stays the same across every page of a cursor walk.
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
List onboarding employees — 200 response body — data item profile
FieldTypePresenceDescription and constraints
$objectRootOnly when the worker has an avatar
pic_urlstringOptionalThe avatar URL of the worker, the same value as `worker.avatar_url`
List onboarding employees — 200 response body — data item app experience
FieldTypePresenceDescription and constraints
$objectRootThe app experience of the employee
experience_typeJSONOptionalThe app experience the employee is given, when there is a specific one
experience_type (anyOf 1)stringAlternativeThe app experience the employee is given, when there is a specific one
Known values: LIGHTWEIGHT
experience_type (anyOf 2)nullAlternative
is_minimal_requirementsbooleanOptionalIndicates if the employee meets minimal requirements
List onboarding employees — 200 response body — data item contract
FieldTypePresenceDescription and constraints
$objectRootThe contract associated with the onboarding
effective_dateJSONOptional
effective_date (anyOf 1)stringAlternativeThe effective date of the contract. Null for a person without a contract
Format: date
effective_date (anyOf 2)nullAlternativeThe effective date of the contract. Null for a person without a contract
Format: date
eorModelOptionalExpand List onboarding employees — 200 response body — data item contract eor
Only for an EOR contract
global_payrollModelOptionalExpand List onboarding employees — 200 response body — data item contract global payroll
Only for a Global Payroll direct employee
idJSONOptional
id (anyOf 1)stringAlternativeThe unique identifier for the contract. Null for a person without a contract
id (anyOf 2)nullAlternativeThe unique identifier for the contract. Null for a person without a contract
is_pwacbooleanOptionalWhether the worker is a person without a contract
offer_letter_idstringOptionalOnly 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
FieldTypePresenceDescription and constraints
$objectRootThe country of the contract
codeJSONOptional
code (anyOf 1)stringAlternativeISO 3166-1 alpha-2 country code
code (anyOf 2)nullAlternativeISO 3166-1 alpha-2 country code
nameJSONOptional
name (anyOf 1)stringAlternativeThe country display name
name (anyOf 2)nullAlternativeThe country display name
List onboarding employees — 200 response body — data item hris profile
FieldTypePresenceDescription and constraints
$objectRootThe profile associated with the onboarding
oidstringOptionalThe unique identifier for the HRIS profile
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeThe work email of the employee
work_email (anyOf 2)nullAlternativeThe work email of the employee

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

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.