Sign in
latestOpenAPI 3.0.1Proprietary2026-08-1844131294.9 KB

59cd6443fdbf

List Employees

Get onboarding tracker

Returns the current onboarding stage for each employee currently in the onboarding 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/onboarding-tracker

Query parameters

employeeIdstring uuid

Filter by employee ID (UUID, exact match)

employeeCodestring

Filter by human-readable employee code (exact match)

Response

Successfully retrieved onboarding tracker list

idstring uuid required

Contract public ID (UUID)

employeeCodestring nullable

Human-readable employee code

stage'DRAFT' | 'CONTRACT_SENT' | 'CONTRACT_SIGNED' | 'EMPLOYEE_INVITED' | 'EMPLOYEE_DETAILS_IN_PROGRESS' | 'VERIFICATION' | 'PAYROLL_SETUP' required
  • DRAFT: Contract is being drafted / defined
  • CONTRACT_SENT: Contract sent for signature
  • CONTRACT_SIGNED: All parties have signed
  • EMPLOYEE_INVITED: Employee invited to the platform
  • EMPLOYEE_DETAILS_IN_PROGRESS: Employee filling in their details
  • VERIFICATION: KYC / identity verification in progress
  • PAYROLL_SETUP: Payroll being configured

Example response

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