Skip to content

Deel: Offboarding schemas

28 Deel schemas with complete fields and constraints.

← Offboarding operations · All schemas

Retrieve offboarding list — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptionalA list of offboarding items.
data[]ModelEach itemExpand Retrieve offboarding list — 200 response body — data item
pageModelOptionalExpand Retrieve offboarding list — 200 response body — page

Referenced models: Retrieve offboarding list — 200 response body — data item, Retrieve offboarding list — 200 response body — page

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

Retrieve offboarding list — 200 response body — data item contract

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalThe contract ID associated with the individual.

Retrieve offboarding list — 200 response body — data item hris profile

FieldTypePresenceDescription and constraints
$objectRoot
oidJSONOptional
oid (anyOf 1)stringAlternativeThe object ID for the HRIS profile of the individual. Null for hiring types without an associated HRIS profile (e.g. contractor, EOR, PEO).
oid (anyOf 2)nullAlternativeThe object ID for the HRIS profile of the individual. Null for hiring types without an associated HRIS profile (e.g. contractor, EOR, PEO).

Retrieve offboarding list — 200 response body — data item progress

FieldTypePresenceDescription and constraints
$objectRoot
reference_dateJSONOptional
reference_date (anyOf 1)stringAlternativeThe reference date for the offboarding status (e.g., the termination date).
reference_date (anyOf 2)nullAlternativeThe reference date for the offboarding status (e.g., the termination date).
reference_date_timezoneJSONOptional
reference_date_timezone (anyOf 1)stringAlternativeThe timezone of the reference date.
reference_date_timezone (anyOf 2)nullAlternativeThe timezone of the reference date.
reference_date_typestringOptionalThe type of reference date (e.g., END_DATE).
statusstringOptionalThe current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS).

Retrieve offboarding list — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONOptional
cursor (anyOf 1)stringAlternativeCursor for pagination to fetch the next page of contractors
cursor (anyOf 2)nullAlternativeCursor for pagination to fetch the next page of contractors
total_rowsJSONOptional
total_rows (anyOf 1)integerAlternativeThe total number of contractors available
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve offboarding list — request body — query pagination

FieldTypePresenceDescription and constraints
$objectRoot
contractIdstringOptionalContract ID for pagination
effectiveDatestringOptionalEffective date for pagination
Format: date-time
progressStatusWeightintegerOptionalProgress status weight for pagination
referenceDatestringOptionalReference date for pagination
Format: date-time

Retrieve termination details by HRIS profile identifier — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Retrieve termination details by HRIS profile identifier — 200 response body — data

Referenced models: Retrieve termination details by HRIS profile identifier — 200 response body — data

Retrieve termination details by HRIS profile identifier — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
app_experienceModelOptionalExpand Retrieve termination details — 200 response body — data app experience
contractModelOptionalExpand Retrieve termination details — 200 response body — data contract
hiring_typestringOptionalThe hiring type for the contract (e.g., contractor).
hris_profileModelOptionalExpand Retrieve termination details by HRIS profile identifier — 200 response body — data hris profile
progressModelOptionalExpand Retrieve termination details by HRIS profile identifier — 200 response body — data progress
summaryarrayOptional
summary[]ModelEach itemExpand Retrieve termination details by HRIS profile identifier — 200 response body — data summary item
terminationModelOptionalExpand Retrieve termination details by HRIS profile identifier — 200 response body — data termination

Referenced models: Retrieve termination details — 200 response body — data app experience, Retrieve termination details by HRIS profile identifier — 200 response body — data progress, Retrieve termination details by HRIS profile identifier — 200 response body — data summary item, Retrieve termination details — 200 response body — data contract, Retrieve termination details by HRIS profile identifier — 200 response body — data hris profile, Retrieve termination details by HRIS profile identifier — 200 response body — data termination

Retrieve termination details by HRIS profile identifier — 200 response body — data hris profile

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe name of the individual in the HRIS profile.
oidstringOptionalThe unique object ID for the HRIS profile.
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeThe work email address of the individual in the HRIS profile.
work_email (anyOf 2)nullAlternativeThe work email address of the individual in the HRIS profile.

Retrieve termination details by HRIS profile identifier — 200 response body — data progress

FieldTypePresenceDescription and constraints
$objectRoot
reference_datestringOptionalThe reference date for the offboarding status (e.g., the termination date).
reference_date_timezonestringOptionalThe timezone of the reference date.
reference_date_typestringOptionalThe type of reference date (e.g., END_DATE).
statusstringOptionalThe current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS).

Retrieve termination details by HRIS profile identifier — 200 response body — data summary item

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Retrieve termination details by HRIS profile identifier — 200 response body — data summary item data
namestringOptionalThe name of the summary item (e.g., Contract ending details).
typestringOptionalThe type of summary information (e.g., CONTRACT_ENDING_DETAILS).
valuestringOptionalThe value or status associated with the summary item.

Referenced models: Retrieve termination details by HRIS profile identifier — 200 response body — data summary item data

Retrieve termination details by HRIS profile identifier — 200 response body — data summary item data

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalThe unique identifier for the contract associated with the summary item.

Retrieve termination details by HRIS profile identifier — 200 response body — data termination

FieldTypePresenceDescription and constraints
$objectRoot
eligible_for_rehireJSONOptional
eligible_for_rehire (anyOf 1)stringAlternativeIndicates whether the individual is eligible for rehire.
eligible_for_rehire (anyOf 2)nullAlternativeIndicates whether the individual is eligible for rehire.
eligible_for_rehire_reasonJSONOptional
eligible_for_rehire_reason (anyOf 1)stringAlternativeThe reason why the individual is or is not eligible for rehire.
eligible_for_rehire_reason (anyOf 2)nullAlternativeThe reason why the individual is or is not eligible for rehire.
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe end date of the contract termination.
end_date (anyOf 2)nullAlternativeThe end date of the contract termination.
ending_typestringOptionalThe type of termination (e.g., ENDING_CONTRACT).
idJSONOptional
id (anyOf 1)stringAlternativeThe termination ID
id (anyOf 2)nullAlternativeThe termination ID
initiated_atJSONOptional
initiated_at (anyOf 1)stringAlternativeThe date and time when the termination was initiated.
initiated_at (anyOf 2)nullAlternativeThe date and time when the termination was initiated.
initiated_byJSONOptionalThe individual that initiated the termination.
initiated_by (anyOf 1)ModelAlternativeExpand Retrieve termination details by HRIS profile identifier — 200 response body — data termination initiated by The individual that initiated the termination
initiated_by (anyOf 2)nullAlternative
public_messageJSONOptional
public_message (anyOf 1)stringAlternativeA public message regarding the termination.
public_message (anyOf 2)nullAlternativeA public message regarding the termination.
termination_impactJSONOptionalThe impact of the termination, if applicable.
termination_impact (anyOf 1)ModelAlternativeExpand Retrieve termination details — 200 response body — data termination termination impact The impact of the termination, if applicable
termination_impact (anyOf 2)nullAlternative

Referenced models: Retrieve termination details by HRIS profile identifier — 200 response body — data termination initiated by The individual that initiated the termination, Retrieve termination details — 200 response body — data termination termination impact The impact of the termination, if applicable

Retrieve termination details by HRIS profile identifier — 200 response body — data termination initiated by The individual that initiated the termination

FieldTypePresenceDescription and constraints
$objectRootThe individual that initiated the termination.
namestringOptionalName of individual
profile_typestringOptionalindividual's type

Retrieve termination details — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Retrieve termination details — 200 response body — data

Referenced models: Retrieve termination details — 200 response body — data

Retrieve termination details — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
app_experienceModelOptionalExpand Retrieve termination details — 200 response body — data app experience
contractModelOptionalExpand Retrieve termination details — 200 response body — data contract
hiring_typestringOptionalThe hiring type for the contract (e.g., contractor).
hris_profileJSONOptional
hris_profile (anyOf 1)ModelAlternativeExpand Retrieve termination details by HRIS profile identifier — 200 response body — data hris profile
hris_profile (anyOf 2)nullAlternative
progressModelOptionalExpand Retrieve termination details — 200 response body — data progress
summaryarrayOptional
summary[]ModelEach itemExpand Retrieve termination details — 200 response body — data summary item
terminationModelOptionalExpand Retrieve termination details — 200 response body — data termination

Referenced models: Retrieve termination details — 200 response body — data app experience, Retrieve termination details — 200 response body — data contract, Retrieve termination details by HRIS profile identifier — 200 response body — data hris profile, Retrieve termination details — 200 response body — data progress, Retrieve termination details — 200 response body — data summary item, Retrieve termination details — 200 response body — data termination

Retrieve termination details — 200 response body — data app experience

FieldTypePresenceDescription and constraints
$objectRoot
is_minimal_requirementsbooleanOptionalIndicates whether the individual meets the minimal experience requirements for the role.

Retrieve termination details — 200 response body — data contract

FieldTypePresenceDescription and constraints
$objectRoot
contract_typestringOptionalThe type of the contract (e.g., payg_tasks).
eorJSONOptionalEmployer of Record (EOR) for the contract, if applicable.
eor (anyOf 1)ModelAlternativeExpand Retrieve termination details — 200 response body — data contract eor probation period
eor (anyOf 2)nullAlternative
idstringOptionalThe unique identifier for the contract.
namestringOptionalThe name or title of the contract.
oidstringOptionalThe object ID for the contract, which might be the same as the contract ID.
timezonestringOptionalThe timezone associated with the contract (e.g., Europe/Belgrade).

Referenced models: Retrieve termination details — 200 response body — data contract eor probation period

Retrieve termination details — 200 response body — data contract eor probation period

FieldTypePresenceDescription and constraints
$objectRootEmployer of Record (EOR) for the contract, if applicable.
probation_periodModelOptionalExpand Retrieve termination details — 200 response body — data contract eor probation period probation period

Referenced models: Retrieve termination details — 200 response body — data contract eor probation period probation period

Retrieve termination details — 200 response body — data contract eor probation period probation period

FieldTypePresenceDescription and constraints
$objectRoot
period_end_atstringOptionalPeriod end date
period_in_daysJSONOptional
period_in_days (anyOf 1)integerAlternativetotal of days of period
period_in_days (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
statusstringOptionalprobation status

Retrieve termination details — 200 response body — data progress

FieldTypePresenceDescription and constraints
$objectRoot
reference_dateJSONOptional
reference_date (anyOf 1)stringAlternativeThe reference date for the offboarding status (e.g., the termination date).
reference_date (anyOf 2)nullAlternativeThe reference date for the offboarding status (e.g., the termination date).
reference_date_timezonestringOptionalThe timezone of the reference date.
reference_date_typestringOptionalThe type of reference date (e.g., END_DATE).
statusstringOptionalThe current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS).

Retrieve termination details — 200 response body — data summary item

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Retrieve termination details — 200 response body — data summary item data
namestringOptionalThe name of the summary item (e.g., Contract ending details).
typestringOptionalThe type of summary information (e.g., CONTRACT_ENDING_DETAILS).
valueJSONOptional
value (anyOf 1)stringAlternativeThe value or status associated with the summary item.
value (anyOf 2)nullAlternativeThe value or status associated with the summary item.

Referenced models: Retrieve termination details — 200 response body — data summary item data

Retrieve termination details — 200 response body — data summary item data

FieldTypePresenceDescription and constraints
$objectRoot
idModelOptionalExpand Retrieve termination details — 200 response body — data summary item data id
The unique identifier for the contract associated with the summary item.

Referenced models: Retrieve termination details — 200 response body — data summary item data id

Retrieve termination details — 200 response body — data summary item data id

FieldTypePresenceDescription and constraints
$JSONRootThe unique identifier for the contract associated with the summary item.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)integerAlternative
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve termination details — 200 response body — data termination

FieldTypePresenceDescription and constraints
$objectRoot
eligible_for_rehireJSONOptional
eligible_for_rehire (anyOf 1)stringAlternativeIndicates whether the individual is eligible for rehire.
eligible_for_rehire (anyOf 2)nullAlternativeIndicates whether the individual is eligible for rehire.
eligible_for_rehire_reasonJSONOptional
eligible_for_rehire_reason (anyOf 1)stringAlternativeThe reason why the individual is or is not eligible for rehire.
eligible_for_rehire_reason (anyOf 2)nullAlternativeThe reason why the individual is or is not eligible for rehire.
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe end date of the contract termination.
end_date (anyOf 2)nullAlternativeThe end date of the contract termination.
ending_typestringOptionalThe type of termination (e.g., ENDING_CONTRACT).
idJSONOptional
id (anyOf 1)stringAlternativeThe termination ID
id (anyOf 2)nullAlternativeThe termination ID
initiated_atJSONOptional
initiated_at (anyOf 1)stringAlternativeThe date and time when the termination was initiated.
initiated_at (anyOf 2)nullAlternativeThe date and time when the termination was initiated.
initiated_byJSONOptionalThe individual that initiated the termination.
initiated_by (anyOf 1)ModelAlternativeExpand Retrieve termination details — 200 response body — data termination initiated by The individual that initiated the termination
initiated_by (anyOf 2)nullAlternative
public_messageJSONOptional
public_message (anyOf 1)stringAlternativeA public message regarding the termination.
public_message (anyOf 2)nullAlternativeA public message regarding the termination.
termination_impactJSONOptionalThe impact of the termination, if applicable.
termination_impact (anyOf 1)ModelAlternativeExpand Retrieve termination details — 200 response body — data termination termination impact The impact of the termination, if applicable
termination_impact (anyOf 2)nullAlternative

Referenced models: Retrieve termination details — 200 response body — data termination termination impact The impact of the termination, if applicable, Retrieve termination details — 200 response body — data termination initiated by The individual that initiated the termination

Retrieve termination details — 200 response body — data termination initiated by The individual that initiated the termination

FieldTypePresenceDescription and constraints
$objectRootThe individual that initiated the termination.
namestringOptionalName of individual
profile_typeJSONOptional
profile_type (anyOf 1)stringAlternativeindividual's type
profile_type (anyOf 2)nullAlternativeindividual's type

Retrieve termination details — 200 response body — data termination termination impact The impact of the termination, if applicable

FieldTypePresenceDescription and constraints
$objectRootThe impact of the termination, if applicable.
descriptionstringOptionalDescription of termination impact
titlestringOptionalTitle of termination impact

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.