Deel: List onboarding employees — 200 response body — data item

API reference · Contract 2026-10-27

SDK schema: 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, 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, 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