---
title: "List employees"
method: GET
path: "/api/v1/employees"
tags: ["Employee"]
---

# List employees

`GET /api/v1/employees`

Lists existing employees

## Query parameters

- `searchTerm` string
- `filter` object[]
  - `key` 'id' | 'name' | 'number', required — Field to filter by.
  - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith', required — Operator to use for filtering.
  - `value` union, required
    - string — Always passed as string in query; backend parses as string, numeric, date, or datetime based on 'key'.
    - string[] — Used for the 'in' operator. Items must be strings representing numeric, date, etc.

## Response `200`

Employee minimal list.

- object
  - `data` object[]
    - `id` string — Resource identifier.
    - `number` string — Employee Number
    - `name` string — Employee Name
    - `email` string — Employee Email

## Other responses

- `400` — IETF RFC 9457 Problem API compliant response
- `403` — Unable to authorize the client
- `404` — Resource was not found or not enough access privileges
- `406` — Requested resource representation does not exist.

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/versions/8a27ba392442/schema)