---
title: "List users"
method: GET
path: "/users"
tags: ["users"]
---

# List users

`GET /users`

Returns a paginated list of client users.

## Query parameters

- `limit` number — The number of items to return
- `cursor` string, cuid — The cursor to return the next page of items

## Headers

- `x-client-id` string, cuid, required — The ID of the client

## Response `200`

Users

- PaginatedUsers
  - `data` ClientUser[], required
    - `id` string, cuid, required — Identifier of the client user.
    - `createdAt` string, date-time, required — The date and time when the client user record was created. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
    - `email` string, email, required — Email address of the client user.
    - `firstName` string, nullable, required — First name of the client user, if provided.
    - `lastName` string, nullable, required — Last name of the client user, if provided.
    - `roles` string[], required — List of role names assigned to the user.
  - `pagination` Pagination, required
    - `nextCursor` string — The cursor to return the next page of items
    - `previousCursor` string — The cursor to return the previous page of items
    - `limit` integer, required — The number of items to return
    - `total` integer, required — The total number of items

## Other responses

- `401` — Unauthorized
- `422` — The validation error(s)
- `429` — Rate limit exceeded
- `500` — Internal server error

---

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