List customers
Paginated; archived customers only with include_archived=true.
Required scope: customers:read.
Scope: customers:read
| Field | Type | Required | Notes |
|---|---|---|---|
| limit(query) | integer | no | Default: 50 · min. 1 · max. 100 |
| offset(query) | integer | no | Default: 0 · min. 0 |
| include_archived(query) | "true" | "false" | no | Default: "false" |
Responses
- 200 Customer list.
- 400 Invalid input.
- 401 API key missing, unknown or revoked. Empty body.
- 403 The key lacks the required scope.
- 429 Too many requests for this key.
- 500 Internal error.
| Field | Type | Required | Notes |
|---|---|---|---|
| data | object[] | yes | |
| data[].id | string (uuid) | yes | |
| data[].customer_number | string | null | yes | |
| data[].customer_type | "company" | "private" | yes | |
| data[].salutation | "herr" | "frau" | null | yes | |
| data[].company_name | string | null | yes | |
| data[].first_name | string | null | yes | |
| data[].last_name | string | null | yes | |
| data[].display_name | string | yes | |
| data[].email | string | null | yes | |
| data[].phone | string | null | yes | |
| data[].mobile_phone | string | null | yes | |
| data[].fax | string | null | yes | |
| data[].address_street | string | null | yes | |
| data[].address_zip | string | null | yes | |
| data[].address_city | string | null | yes | |
| data[].tax_id | string | null | yes | |
| data[].notes | string | null | yes | |
| data[].is_archived | boolean | yes | |
| data[].created_at | string | yes | |
| data[].updated_at | string | null | yes | |
| pagination | object | yes | |
| pagination.limit | integer | yes | |
| pagination.offset | integer | yes | |
| pagination.total | integer | yes |