---
title: "List Employees"
method: POST
path: "/employees/v1/query"
tags: ["Employees"]
---

# List Employees

`POST /employees/v1/query`

List all employees in your organisation.

## Request body

- ListEmployeesRequestDto
  - `sortBy` SortOptionListEmployeesSortBy[]
    - `field` 'Id', required — Sorting options for the list of employees.
    - `isAscending` boolean
  - `filters` ListEmployeesFilters — Filters for the list of employees.
    - `externalReference` string, nullable — Filter by external reference. If null, no filtering is performed.
    - `email` string, nullable — Filter by email address. If null, no filtering is performed.
    - `isTerminated` boolean
  - `continuationToken` string, nullable — The continuation token from the previous response, or `null` for the first page.
  - `pageSize` integer

## Response `200`

OK

- ListResponseDtoEmployeeDto — A paginated list of items.
  - `items` EmployeeDto[], required
    - `id` string, uuid, required
    - `name` EmployeeNameDto, required
      - `givenName` string, required
      - `familyName` string, required
    - `employment` EmploymentDto, required
      - `jobTitle` string, nullable, required
      - `start` string, date, required
      - `end` string, date, required
      - `payrollNumber` string, nullable, required
    - `email` string, required — Email address of the employee. This is unique within the organisation.
    - `externalReference` string, nullable, required — An external reference you can set for the employee. Multiple employees can have the same external reference.
    - `_metadata` EmployeeMetadataDto, required
      - `isRegistered` boolean, required
      - `isTerminated` boolean, required
  - `continuationToken` string, nullable — The continuation token for the next page, or `null` if this is the last page.

## Other responses

- `401` — Token Expired. Re-authenticate to obtain a new token.
- `403` — Forbidden
- `422` — Validation failed

---

[API](https://skmtc.dev/bright/apis/customer-api.md) · [All operations](https://skmtc.dev/bright/apis/customer-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bright/customer-api/revisions/77b0e300c3a5/schema)