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 progress
List onboarding employees: 200 response body, field data / item / overview / actions, app_experience, banner, checklist, contract, contracts, hiring_type, hris_profile, profile, progress, stepper, summary / progress. Complete fields and constraints for contract 2026-10-27.
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 progress
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Progress of the onboarding process |
is_action_required_from_client | boolean | Optional | Indicates if action is required from the client |
reference_date | JSON | Optional | |
reference_date (anyOf 1) | string | Alternative | Reference date for the progress Format: date-time |
reference_date (anyOf 2) | null | Alternative | Reference date for the progress Format: date-time |
reference_date_timezone | JSON | Optional | |
reference_date_timezone (anyOf 1) | string | Alternative | Timezone of the reference date |
reference_date_timezone (anyOf 2) | null | Alternative | Timezone of the reference date |
status | string | Optional | Current status of the onboarding process (e.g., ACTIVE) |
sub_status | JSON | Optional | Finer state within the status, when there is one |
sub_status (anyOf 1) | string | Alternative | Finer state within the status, when there is one Known values: PENDING_INVITE, INVITED, ONBOARDING, AWAITING_CLIENT_REVIEW, CANCELLED, REJECTED |
sub_status (anyOf 2) | null | Alternative | |
subject_to_overdue | boolean | Optional | Indicates if the onboarding is subject to overdue |