Skip to main content
GET
/
admin
/
clients
List clients
curl --request GET \
  --url https://api.steuerboard.com/v1/admin/clients \
  --header 'Authorization: Bearer <token>'
{
  "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
  }
}
This endpoint only works with the Accountant API key. More information here

Authorizations

​
Authorization
string
header
required

Bearer token authentication

Query Parameters

​
limit
number
default:20

The number of items to return

Required range: 1 <= x <= 100
Example:

20

​
cursor
string<cuid>

The cursor to return the next page of items

Example:

"cmf41ajzv003706un4i99q19z"

​
customId
string

The custom ID of the client

Example:

"455148"

​
slug
string

The slug of the client

Example:

"muster-gmbh"

​
archived
enum<string>
default:false

Include archived clients

Available options:
true,
false
Example:

"false"

​
type
enum<string>

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.

Available options:
natural_person,
individual_enterprise,
legal_person
Example:

"legal_person"

​
sort
enum<string>
default:createdAt

The sort field of the results

Available options:
createdAt,
updatedAt,
archivedAt,
name,
customId
Example:

"createdAt"

​
order
enum<string>
default:desc

The order of the results based on the sort field

Available options:
asc,
desc
Example:

"desc"

Response

Clients

​
data
object[]
required
​
pagination
object
required