latestOpenAPI 3.0.1Proprietary2026-08-1844131294.9 KB

59cd6443fdbf

Approver Management3

Create GP Employment3

Customer Departments3

Customer Entities1

Customer Users4

Customers2

Dev Support2

Employee Address Details1

Employee Bank Details1

Employee Compensation Details3

Employee Contact Details1

Employee Education Details1

Employee Employment Details2

Employee Personal Details1

expenses2

JWKS Controller1

List Employees4

Magic Links3

OAuth1

Partner Token1

Time Offs2

Timesheet2

List Employees

Get offboarding tracker

Returns the current offboarding stage for each employee currently in the offboarding lifecycle.

Optional filters narrow the result to a specific employee. When both filters are provided they are applied as an AND (intersection).

get/v1/employees/offboarding-tracker

Query parameters

employeeIdstring uuid

Filter by employee ID (UUID, exact match)

employeeCodestring

Filter by human-readable employee code (exact match)

Response

Successfully retrieved offboarding tracker list

idstring uuid required

Contract public ID (UUID)

employeeCodestring nullable

Human-readable employee code

stage'OFFBOARDING_INITIATED' | 'DOCUMENTS_PENDING' | 'SETTLEMENT_PENDING' | 'SETTLEMENT_COMPLETE' required

OFFBOARDING_INITIATED: Offboarding process has started
DOCUMENTS_PENDING: Waiting for required documents
SETTLEMENT_PENDING: Waiting for final settlement
SETTLEMENT_COMPLETE: Final settlement completed

pendingDocumentsOffboardingPendingDocument[] nullable

List of pending documents when stage is DOCUMENTS_PENDING

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "employeeCode": "EMP-12345",
    "stage": "DOCUMENTS_PENDING",
    "pendingDocuments": [
      "WET_INK_LETTER"
    ]
  }
]