Deel: List onboarding employees — 200 response body — data item overview actions, app experience, banner, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary

API reference · Contract 2026-10-27

SDK schema: List onboarding employees — 200 response body — data item overview actions, app experience, banner, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary

Field	Type	Presence	Description and constraints
$	object	Root	Only with `include_overview`. The onboarding overview of the contract, as `GET /onboarding/tracker/{tracker_id}` returns it in `data`
actions	array	Optional	Actions the caller can take on this onboarding
actions[]	Model	Each item	Expand Get onboarding details by onboarding tracker ID — 200 response body — data actions item
app_experience	Model	Optional	Expand Get onboarding details by onboarding tracker ID — 200 response body — data app experience The app experience of the employee
banner	JSON	Optional	The one thing worth saying about this worker, or null when there is nothing
banner (anyOf 1)	Model	Alternative	Expand Get onboarding details by onboarding tracker ID — 200 response body — data / banner / severity: ERROR, WARNING, INFO
banner (anyOf 2)	null	Alternative
checklist	Model	Optional	Expand Get onboarding details by onboarding tracker ID — 200 response body — data checklist List of checklist steps
contract	Model	Optional	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 contract Information about the contract
contracts	array	Optional	Every contract of the worker the caller can see, the main one first
contracts[]	Model	Each item	Expand Get onboarding details by onboarding tracker ID — 200 response body — data contracts item
hiring_type	string	Optional	Hiring type (e.g., contractor)
hris_profile	JSON	Optional	Employee HRIS profile information
hris_profile (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 hris profile Employee HRIS profile information
hris_profile (anyOf 2)	null	Alternative
profile	JSON	Optional	Employee profile information
profile (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 profile Employee profile information
profile (anyOf 2)	null	Alternative
progress	Model	Optional	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 progress Progress of the onboarding process
stepper	array	Optional	List of stepper actions taken during the onboarding process
stepper[]	Model	Each item	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 stepper item
summary	array	Optional	Summary of the onboarding process
summary[]	Model	Each item	Expand Get onboarding details by onboarding tracker ID — 200 response body — data summary item

Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data actions item, Get onboarding details by onboarding tracker ID — 200 response body — data app experience, Get onboarding details by onboarding tracker ID — 200 response body — data / banner / severity: ERROR, WARNING, INFO, Get onboarding details by onboarding tracker ID — 200 response body — data checklist, List onboarding employees — 200 response body — data item overview actions, app experience, banner, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary contract, Get onboarding details by onboarding tracker ID — 200 response body — data contracts item, List onboarding employees — 200 response body — data item overview actions, app experience, banner, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary hris profile Employee HRIS profile information, List onboarding employees — 200 response body — data item overview actions, app experience, banner, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary profile Employee profile information, List onboarding employees — 200 response body — data item overview actions, app experience, banner, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary progress, List onboarding employees — 200 response body — data item overview actions, app experience, banner, checklist, contract, contracts, hiring type, hris profile, profile, progress, stepper, summary stepper item, Get onboarding details by onboarding tracker ID — 200 response body — data summary item