v1

latestOpenAPI 3.1.12026-07-124448163.2 KB

admin.clients

List clients

Returns a paginated list of clients.

get/admin/clients

Query parameters

limitnumber

The number of items to return

Example:20

cursorstring cuid

The cursor to return the next page of items

Example:cmf41ajzv003706un4i99q19z

customIdstring

The custom ID of the client

Example:455148

slugstring

The slug of the client

Example:muster-gmbh

archived'true' | 'false'

Include archived clients

Example:false

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.

Example:legal_person

sort'createdAt' | 'updatedAt' | 'archivedAt' | 'name' | 'customId'

The sort field of the results

Example:createdAt

order'asc' | 'desc'

The order of the results based on the sort field

Example:desc

Response

Clients

Example response

{
  "data": [
    {
      "id": "cmf41ajzv003706un4i99q19z",
      "name": "Muster GmbH",
      "slug": "muster-gmbh",
      "type": "legal_person",
      "customId": "ABC123",
      "legalName": "Muster GmbH",
      "archivedAt": "2021-01-01T00:00:00Z",
      "datevClientId": "ABC123",
      "createdAt": "2021-01-01T00:00:00Z",
      "updatedAt": "2021-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "nextCursor": "cmf41ajzv003706un4i99q19z",
    "previousCursor": "cmf41ajzv003706un4i99q19z",
    "limit": 20,
    "total": 134
  }
}