Offboarding tracker

The offboarding tracker endpoints let you query offboarding status across all your workers without a specific contract ID. Use these to build dashboards, sync offboarding state into external HR systems, or look up a termination record when you only have an HRIS profile identifier.

For an overview of all offboarding flows, see EOR offboarding.

Prerequisites

• Client API token: All tracker endpoints require a client API token. See Authentication.
• OAuth scopes: All tracker endpoints require the contracts:read and people:read scopes.

List offboarding records

Use the Retrieve offboarding list endpoint to retrieve a paginated list of offboarding records across all contracts. Each record includes the contract, current progress status, hiring type, and a termination_id when applicable.

$
curl --location --request GET \
>
  '{{host}}/rest/offboarding/tracker?limit=20&hiring_types=employee&progress_statuses=ACTIVE' \
>
  --header 'Authorization: Bearer {{client_token}}'

The response contains a data array of offboarding records and a page object with cursor and total_rows for pagination. Each record includes termination_id: use this as the {id} path parameter in the next two endpoints.

Retrieve termination details

Use the Retrieve termination details endpoint to get full details for a specific offboarding record by its tracker ID. The id is the termination_id value returned in the list response.

$
curl --location --request GET \
>
  '{{host}}/rest/offboarding/tracker/{{tracker_id}}' \
>
  --header 'Authorization: Bearer {{client_token}}'

The response includes the contract details, current progress status, termination information (end date, type, and rehire eligibility), and HRIS profile data.

Retrieve termination details by HRIS profile

Use the Retrieve termination details by HRIS profile identifier endpoint to look up a termination record using the worker’s HRIS profile OID instead of a tracker ID. This is useful when integrating with HRIS systems where the OID is the primary identifier.

$
curl --location --request GET \
>
  '{{host}}/rest/offboarding/tracker/hris_profile/{{hris_oid}}' \
>
  --header 'Authorization: Bearer {{client_token}}'

The hris_oid is available as hris_profile.oid in the list response or from your HRIS sync. The response shape is identical to the tracker ID lookup, including contract, progress, termination, and HRIS profile fields.

Next steps