Deel: List onboarding employees — 200 response body — data item contracts item
List onboarding employees: 200 response body, field data / item / contracts / item. 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 contracts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_oid | JSON | Optional | |
contract_oid (anyOf 1) | string | Alternative | The unique identifier for the contract |
contract_oid (anyOf 2) | null | Alternative | The unique identifier for the contract |
entity | JSON | Optional | The legal entity the contract sits under. Null when there is none |
entity (anyOf 1) | Model | Alternative | Expand Get onboarding details by onboarding tracker ID — 200 response body — data contracts item entity id, name |
entity (anyOf 2) | null | Alternative | |
is_attention_needed | boolean | Optional | Whether the onboarding on this contract is overdue or at risk |
is_main | boolean | Optional | Whether this is the main contract of the worker: the most urgent status, then a new contract before a person without a contract, then the latest start date, then the latest created contract |
is_pwac | boolean | Optional | Whether the contract is the placeholder contract of a person without a contract |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | The job title on the contract |
job_title (anyOf 2) | null | Alternative | The job title on the contract |
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 |
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 |
status | string | Optional | Current status of the onboarding on this contract Known values: ONBOARDING_AT_RISK, ONBOARDING_OVERDUE, INVITED, ONBOARDING, READY_TO_START, INACTIVE, PENDING_INVITE, ACTIVE, DRAFT, OFFBOARDING, QUOTE_REQUIRES_CHANGES, IN_REVIEW, IN_OFFER_STAGE |
tracker_id | string | Optional | The tracker identifier that loads this contract |
worker_type | string | Optional | The worker type of the contract, as the hiring_types filter takes it Known values: contractor, direct_employee, hris_direct_employee, hris_direct_contractor, eor, peo, person_without_contract |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data contracts item entity id, name