Deel: Retrieve offboarding list — 200 response body — data item
Retrieve offboarding list: 200 response body, field data / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Retrieve offboarding list — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
app_experience | Model | Optional | Expand Retrieve termination details — 200 response body — data app experience |
contract | Model | Optional | Expand Retrieve offboarding list — 200 response body — data item contract |
hiring_type | string | Optional | The hiring type for the individual (e.g., contractor). |
hris_profile | Model | Optional | Expand Retrieve offboarding list — 200 response body — data item hris profile |
name | string | Optional | The name of the individual associated with the offboarding. |
offboarding_type | string | Optional | The type of offboarding. Known values: TERMINATION, RESIGNATION, ENDING_CONTRACT |
progress | Model | Optional | Expand Retrieve offboarding list — 200 response body — data item progress |
termination_id | JSON | Optional | |
termination_id (anyOf 1) | string | Alternative | The termination ID if the individual has been terminated. |
termination_id (anyOf 2) | null | Alternative | The termination ID if the individual has been terminated. |
unique_id | string | Optional | Base64url-encoded JSON token identifying this offboarding tracker. Decodes to `{“contractOid”:“<oid>”,“hiringType”:“<type>”}`. Pass as the `id` path parameter to tracker detail or checklist endpoints. Obtain from the API — never construct manually. Format: base64url |
Referenced models: Retrieve termination details — 200 response body — data app experience, Retrieve offboarding list — 200 response body — data item contract, Retrieve offboarding list — 200 response body — data item hris profile, Retrieve offboarding list — 200 response body — data item progress