Deel: Retrieve offboarding list
Deel offboarding.retrieveOffboardingList: arguments, response, policy and SDK examples.
← Offboarding operations · Get started
Operation deel.offboarding_retrieveoffboardinglist_v2026_01_01
Provider route: GET /offboarding/tracker. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["offboarding"]["retrieveOffboardingList"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.offboarding.retrieveOffboardingList(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.offboarding.retrieve_offboarding_list(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.search | string | Optional | |
query.hiring_types | array | Optional | Default: [] |
query.hiring_types[] | string | Each item | One of: contractor, eor, peo, hris_direct_employee, direct_employee, person_without_contract |
query.progress_statuses | array | Optional | Default: [] |
query.progress_statuses[] | string | Each item | One of: IN_REVIEW, DOCUMENT_PROCESSING, EMPLOYEE_OFFBOARDING, FINAL_PAYMENT_AND_REFUND, COMPLETED, AWAITING_CLIENT_SIGNATURE, AWAITING_CONTRACTOR_SIGNATURE, TERMINATION_LETTER_REJECTED, CONTRACT_ENDING, CONTRACT_ENDED, OFFBOARDING, INACTIVE, AWAITING_TERMINATION_DETAILS |
query.limit | integer | Optional | Default: 20 Maximum: 100 Minimum: 1 |
query.sort_by | string | Optional | Default: progressStatusWeight One of: progressStatusWeight |
query.sort_order | string | Optional | Default: ASC One of: ASC, DESC |
query.pagination | Model | Optional | Expand Retrieve offboarding list — request body — query pagination |
query.cursor | string | Optional | Maximum length: 2048 |
query.include_overview | boolean | Optional | Default: false |
query.ignore_date_range | boolean | Optional | Default: false |
Referenced models: Retrieve offboarding list — request body — query pagination
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve offboarding list — 200 response body |
Referenced models: Retrieve offboarding list — 200 response body
Schemas
Section titled “Schemas”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 offboarding list — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | A list of offboarding items. |
data[] | Model | Each item | Expand Retrieve offboarding list — 200 response body — data item |
page | Model | Optional | Expand 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
| 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
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 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 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). |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.offboarding_retrieveoffboardinglist_v2026_01_01. Catalog operation: offboarding_retrieveoffboardinglist_v2026_01_01. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["contracts:read", "people:read"]
Pinned headers: {"X-Version": "2026-01-01"}