Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
app_experienceModelOptionalExpand Retrieve termination details — 200 response body — data app experience
contractModelOptionalExpand Retrieve offboarding list — 200 response body — data item contract
hiring_typestringOptionalThe hiring type for the individual (e.g., contractor).
hris_profileModelOptionalExpand Retrieve offboarding list — 200 response body — data item hris profile
namestringOptionalThe name of the individual associated with the offboarding.
offboarding_typestringOptionalThe type of offboarding.
Known values: TERMINATION, RESIGNATION, ENDING_CONTRACT
progressModelOptionalExpand Retrieve offboarding list — 200 response body — data item progress
termination_idJSONOptional
termination_id (anyOf 1)stringAlternativeThe termination ID if the individual has been terminated.
termination_id (anyOf 2)nullAlternativeThe termination ID if the individual has been terminated.
unique_idstringOptionalBase64url-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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.