---
title: "Get onboarding tracker"
method: GET
path: "/v1/employees/onboarding-tracker"
tags: ["List Employees"]
---

# Get onboarding tracker

`GET /v1/employees/onboarding-tracker`

## Request

- Base URL: `https://api.usemultiplier.com`
- URL: `https://api.usemultiplier.com/v1/employees/onboarding-tracker`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/usemultiplier/apis/multiplier-public-rest-api/docs/v1/employees/onboarding-tracker/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Query parameters

- `employeeId` string, uuid
- `employeeCode` string

## Response `200`

Successfully retrieved onboarding tracker list

- OnboardingTrackerItem[]
  - `id` string, uuid, required: Contract public ID (UUID)
  - `employeeCode` string, 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

## Other responses

- `401`: Authentication required
- `403`: Forbidden - insufficient permissions
- `500`: Internal server error
- `503`: Service unavailable - upstream dependency error

---

[API](https://skmtc.dev/usemultiplier/apis/multiplier-public-rest-api.md) - [All operations](https://skmtc.dev/usemultiplier/apis/multiplier-public-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/usemultiplier/apis/multiplier-public-rest-api/revisions/da31bb6ec00d?raw)