Deel: List onboarding employees — 200 response body — data item progress steps completed, in progress, in review, not started, overdue, total
List onboarding employees: 200 response body, field data / item / progress / steps / completed, in_progress, in_review, not_started, overdue, total. 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 steps completed, in progress, in review, not started, overdue, total
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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 |
completed | JSON | Optional | |
completed (anyOf 1) | integer | Alternative | Completed steps |
completed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
in_progress | JSON | Optional | |
in_progress (anyOf 1) | integer | Alternative | Steps started but not completed |
in_progress (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
in_review | JSON | Optional | |
in_review (anyOf 1) | integer | Alternative | Steps waiting for a review |
in_review (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
not_started | JSON | Optional | |
not_started (anyOf 1) | integer | Alternative | Steps not started yet |
not_started (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
overdue | JSON | Optional | |
overdue (anyOf 1) | integer | Alternative | Steps past their due date and not completed |
overdue (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total | JSON | Optional | |
total (anyOf 1) | integer | Alternative | Number of checklist steps |
total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |