---
title: "List clients"
method: GET
path: "/admin/clients"
tags: ["admin.clients"]
---

# List clients

`GET /admin/clients`

Returns a paginated list of clients.

## Query parameters

- `limit` number — The number of items to return
- `cursor` string, cuid — The cursor to return the next page of items
- `customId` string — The custom ID of the client
- `slug` string — The slug of the client
- `archived` 'true' | 'false' — Include archived clients
- `type` 'natural_person' | 'individual_enterprise' | 'legal_person' — The type of the client. 'natural_person' for individuals, 'legal_person' for companies like UG, GmbH, AG, Ltd., Inc., etc. and 'individual_enterprise' for sole proprietorships.
- `sort` 'createdAt' | 'updatedAt' | 'archivedAt' | 'name' | 'customId' — The sort field of the results
- `order` 'asc' | 'desc' — The order of the results based on the sort field

## Response `200`

Clients

- PaginatedClients
  - `data` Client[], required
    - `id` string, cuid, required — The ID of the client
    - `name` string, required — The name of the client
    - `slug` string, required — The slug of the client
    - `type` 'natural_person' | 'individual_enterprise' | 'legal_person', required — The type of the client. 'natural_person' for individuals, 'legal_person' for companies like UG, GmbH, AG, Ltd., Inc., etc. and 'individual_enterprise' for sole proprietorships.
    - `customId` string, nullable, required — The client's custom ID can be defined by the accountant
    - `legalName` string, nullable, required — The legal name of the client
    - `archivedAt` string, date-time, nullable, required — The date and time the client was archived. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
    - `datevClientId` string, nullable, required — The client's ID in DATEV
    - `createdAt` string, date-time, required — The date and time of the creation for the client. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
    - `updatedAt` string, date-time, required — The date and time of the last update for the client. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
  - `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)