← Offboarding operations · All schemas
Retrieve offboarding list — 200 response body
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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
id | string | Optional | The contract ID associated with the individual. |
Retrieve offboarding list — 200 response body — data item hris profile
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
oid | JSON | Optional | |
oid (anyOf 1) | string | Alternative | The 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) | null | Alternative | The 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
reference_date | JSON | Optional | |
reference_date (anyOf 1) | string | Alternative | The reference date for the offboarding status (e.g., the termination date). |
reference_date (anyOf 2) | null | Alternative | The reference date for the offboarding status (e.g., the termination date). |
reference_date_timezone | JSON | Optional | |
reference_date_timezone (anyOf 1) | string | Alternative | The timezone of the reference date. |
reference_date_timezone (anyOf 2) | null | Alternative | The timezone of the reference date. |
reference_date_type | string | Optional | The type of reference date (e.g., END_DATE). |
status | string | Optional | The current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS). |
Retrieve offboarding list — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
cursor | JSON | Optional | |
cursor (anyOf 1) | string | Alternative | Cursor for pagination to fetch the next page of contractors |
cursor (anyOf 2) | null | Alternative | Cursor for pagination to fetch the next page of contractors |
total_rows | JSON | Optional | |
total_rows (anyOf 1) | integer | Alternative | The total number of contractors available |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve offboarding list — request body — query pagination
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
contractId | string | Optional | Contract ID for pagination |
effectiveDate | string | Optional | Effective date for pagination Format: date-time |
progressStatusWeight | integer | Optional | Progress status weight for pagination |
referenceDate | string | Optional | Reference date for pagination Format: date-time |
Retrieve termination details by HRIS profile identifier — 200 response body
Referenced models: Retrieve termination details by HRIS profile identifier — 200 response body — data
Retrieve termination details by HRIS profile identifier — 200 response body — data
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
name | string | Optional | The name of the individual in the HRIS profile. |
oid | string | Optional | The unique object ID for the HRIS profile. |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | The work email address of the individual in the HRIS profile. |
work_email (anyOf 2) | null | Alternative | The work email address of the individual in the HRIS profile. |
Retrieve termination details by HRIS profile identifier — 200 response body — data progress
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
reference_date | string | Optional | The reference date for the offboarding status (e.g., the termination date). |
reference_date_timezone | string | Optional | The timezone of the reference date. |
reference_date_type | string | Optional | The type of reference date (e.g., END_DATE). |
status | string | Optional | The current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS). |
Retrieve termination details by HRIS profile identifier — 200 response body — data 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
id | string | Optional | The unique identifier for the contract associated with the summary item. |
Retrieve termination details by HRIS profile identifier — 200 response body — data termination
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
eligible_for_rehire | JSON | Optional | |
eligible_for_rehire (anyOf 1) | string | Alternative | Indicates whether the individual is eligible for rehire. |
eligible_for_rehire (anyOf 2) | null | Alternative | Indicates whether the individual is eligible for rehire. |
eligible_for_rehire_reason | JSON | Optional | |
eligible_for_rehire_reason (anyOf 1) | string | Alternative | The reason why the individual is or is not eligible for rehire. |
eligible_for_rehire_reason (anyOf 2) | null | Alternative | The reason why the individual is or is not eligible for rehire. |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The end date of the contract termination. |
end_date (anyOf 2) | null | Alternative | The end date of the contract termination. |
ending_type | string | Optional | The type of termination (e.g., ENDING_CONTRACT). |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The termination ID |
id (anyOf 2) | null | Alternative | The termination ID |
initiated_at | JSON | Optional | |
initiated_at (anyOf 1) | string | Alternative | The date and time when the termination was initiated. |
initiated_at (anyOf 2) | null | Alternative | The date and time when the termination was initiated. |
initiated_by | JSON | Optional | The individual that initiated the termination. |
initiated_by (anyOf 1) | Model | Alternative | Expand Retrieve termination details by HRIS profile identifier — 200 response body — data termination initiated by The individual that initiated the termination |
initiated_by (anyOf 2) | null | Alternative | |
public_message | JSON | Optional | |
public_message (anyOf 1) | string | Alternative | A public message regarding the termination. |
public_message (anyOf 2) | null | Alternative | A public message regarding the termination. |
termination_impact | JSON | Optional | The impact of the termination, if applicable. |
termination_impact (anyOf 1) | Model | Alternative | Expand Retrieve termination details — 200 response body — data termination termination impact The impact of the termination, if applicable |
termination_impact (anyOf 2) | null | Alternative | |
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | The individual that initiated the termination. |
name | string | Optional | Name of individual |
profile_type | string | Optional | individual's type |
Retrieve termination details — 200 response body
Referenced models: Retrieve termination details — 200 response body — data
Retrieve termination details — 200 response body — data
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
is_minimal_requirements | boolean | Optional | Indicates whether the individual meets the minimal experience requirements for the role. |
Retrieve termination details — 200 response body — data contract
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
contract_type | string | Optional | The type of the contract (e.g., payg_tasks). |
eor | JSON | Optional | Employer of Record (EOR) for the contract, if applicable. |
eor (anyOf 1) | Model | Alternative | Expand Retrieve termination details — 200 response body — data contract eor probation period |
eor (anyOf 2) | null | Alternative | |
id | string | Optional | The unique identifier for the contract. |
name | string | Optional | The name or title of the contract. |
oid | string | Optional | The object ID for the contract, which might be the same as the contract ID. |
timezone | string | Optional | The 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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
period_end_at | string | Optional | Period end date |
period_in_days | JSON | Optional | |
period_in_days (anyOf 1) | integer | Alternative | total of days of period |
period_in_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
status | string | Optional | probation status |
Retrieve termination details — 200 response body — data progress
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
reference_date | JSON | Optional | |
reference_date (anyOf 1) | string | Alternative | The reference date for the offboarding status (e.g., the termination date). |
reference_date (anyOf 2) | null | Alternative | The reference date for the offboarding status (e.g., the termination date). |
reference_date_timezone | string | Optional | The timezone of the reference date. |
reference_date_type | string | Optional | The type of reference date (e.g., END_DATE). |
status | string | Optional | The current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS). |
Retrieve termination details — 200 response body — data summary item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
data | Model | Optional | Expand Retrieve termination details — 200 response body — data summary item data |
name | string | Optional | The name of the summary item (e.g., Contract ending details). |
type | string | Optional | The type of summary information (e.g., CONTRACT_ENDING_DETAILS). |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | The value or status associated with the summary item. |
value (anyOf 2) | null | Alternative | The 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
Referenced models: Retrieve termination details — 200 response body — data summary item data id
Retrieve termination details — 200 response body — data summary item data id
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The unique identifier for the contract associated with the summary item. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | integer | Alternative | |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve termination details — 200 response body — data termination
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
eligible_for_rehire | JSON | Optional | |
eligible_for_rehire (anyOf 1) | string | Alternative | Indicates whether the individual is eligible for rehire. |
eligible_for_rehire (anyOf 2) | null | Alternative | Indicates whether the individual is eligible for rehire. |
eligible_for_rehire_reason | JSON | Optional | |
eligible_for_rehire_reason (anyOf 1) | string | Alternative | The reason why the individual is or is not eligible for rehire. |
eligible_for_rehire_reason (anyOf 2) | null | Alternative | The reason why the individual is or is not eligible for rehire. |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The end date of the contract termination. |
end_date (anyOf 2) | null | Alternative | The end date of the contract termination. |
ending_type | string | Optional | The type of termination (e.g., ENDING_CONTRACT). |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The termination ID |
id (anyOf 2) | null | Alternative | The termination ID |
initiated_at | JSON | Optional | |
initiated_at (anyOf 1) | string | Alternative | The date and time when the termination was initiated. |
initiated_at (anyOf 2) | null | Alternative | The date and time when the termination was initiated. |
initiated_by | JSON | Optional | The individual that initiated the termination. |
initiated_by (anyOf 1) | Model | Alternative | Expand Retrieve termination details — 200 response body — data termination initiated by The individual that initiated the termination |
initiated_by (anyOf 2) | null | Alternative | |
public_message | JSON | Optional | |
public_message (anyOf 1) | string | Alternative | A public message regarding the termination. |
public_message (anyOf 2) | null | Alternative | A public message regarding the termination. |
termination_impact | JSON | Optional | The impact of the termination, if applicable. |
termination_impact (anyOf 1) | Model | Alternative | Expand Retrieve termination details — 200 response body — data termination termination impact The impact of the termination, if applicable |
termination_impact (anyOf 2) | null | Alternative | |
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | The individual that initiated the termination. |
name | string | Optional | Name of individual |
profile_type | JSON | Optional | |
profile_type (anyOf 1) | string | Alternative | individual's type |
profile_type (anyOf 2) | null | Alternative | individual's type |
Retrieve termination details — 200 response body — data termination termination impact The impact of the termination, if applicable
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | The impact of the termination, if applicable. |
description | string | Optional | Description of termination impact |
title | string | Optional | Title of termination impact |