Deel: List onboarding employees — 200 response body — data item progress
List onboarding employees: 200 response body, field data / item / 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 progress
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The progress state of the onboarding |
is_action_required_from_client | JSON | Optional | |
is_action_required_from_client (anyOf 1) | boolean | Alternative | Whether action is required from the client |
is_action_required_from_client (anyOf 2) | null | Alternative | Whether action is required from the client |
lifecycle_status | string | Optional | Lifecycle status of this contract, the same value the People list shows for it Known values: DRAFT, IN_REVIEW, QUOTE_REQUIRES_CHANGES, PENDING_INVITE, INVITED, ONBOARDING, ONBOARDING_AT_RISK, ONBOARDING_OVERDUE, OFFBOARDING, ONBOARDED |
onboarding_due_date | Model | Optional | Expand List onboarding employees — 200 response body — data item progress onboarding due date Due date for onboarding |
people_list_status | string | Optional | Status of the people list |
reference_date | Model | Optional | Expand List onboarding employees — 200 response body — data item progress reference date The reference date determining the onboarding status |
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 |
reference_date_type | JSON | Optional | |
reference_date_type (anyOf 1) | string | Alternative | Type of the reference date (e.g., EFFECTIVE_DATE) |
reference_date_type (anyOf 2) | null | Alternative | Type of the reference date (e.g., EFFECTIVE_DATE) |
status | string | Optional | Current status of the onboarding |
steps | JSON | Optional | Onboarding checklist step counts per state. Null when the counts are not available: the worker has no checklist yet, the row is a contractor draft or a draft quote, or the steps could not be read |
steps (anyOf 1) | Model | Alternative | Expand List onboarding employees — 200 response body — data item progress steps completed, in progress, in review, not started, overdue, total |
steps (anyOf 2) | null | Alternative | |
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 | Whether the onboarding is subject to overdue |
waiting_on | JSON | Optional | The party whose action the onboarding waits on. Null when nothing is outstanding, which includes a settled onboarding (READY_TO_START, ACTIVE, OFFBOARDING, INACTIVE) with no client action required |
waiting_on (anyOf 1) | string | Alternative | The party whose action the onboarding waits on. Null when nothing is outstanding, which includes a settled onboarding (READY_TO_START, ACTIVE, OFFBOARDING, INACTIVE) with no client action required Known values: WORKER, CLIENT, DEEL |
waiting_on (anyOf 2) | null | Alternative |
Referenced models: List onboarding employees — 200 response body — data item progress onboarding due date, List onboarding employees — 200 response body — data item progress reference date, List onboarding employees — 200 response body — data item progress steps completed, in progress, in review, not started, overdue, total