Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.searchstringOptional
query.hiring_typesarrayOptionalDefault: []
query.hiring_types[]stringEach itemOne of: contractor, eor, peo, hris_direct_employee, direct_employee, person_without_contract
query.progress_statusesarrayOptionalDefault: []
query.progress_statuses[]stringEach itemOne 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.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1
query.sort_bystringOptionalDefault: progressStatusWeight
One of: progressStatusWeight
query.sort_orderstringOptionalDefault: ASC
One of: ASC, DESC
query.paginationModelOptionalExpand Retrieve offboarding list — request body — query pagination
query.cursorstringOptionalMaximum length: 2048
query.include_overviewbooleanOptionalDefault: false
query.ignore_date_rangebooleanOptionalDefault: false

Referenced models: Retrieve offboarding list — request body — query pagination

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve offboarding list — 200 response body

Referenced models: Retrieve offboarding list — 200 response body

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 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 — 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 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 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).

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"}

Official provider source

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.