Klanten opvragen
Per pagina; gearchiveerde klanten alleen met include_archived=true.
Vereiste scope: customers:read.
Scope: customers:read
| Veld | Type | Verplicht | Opmerkingen |
|---|---|---|---|
| limit(query) | integer | nee | Standaard: 50 · min. 1 · max. 100 |
| offset(query) | integer | nee | Standaard: 0 · min. 0 |
| include_archived(query) | "true" | "false" | nee | Standaard: "false" |
Antwoorden
- 200 Klantenlijst.
- 400 Ongeldige invoer.
- 401 API-sleutel ontbreekt, is onbekend of ingetrokken. Lege body.
- 403 De sleutel mist de vereiste scope.
- 429 Te veel verzoeken voor deze sleutel.
- 500 Interne fout.
| Veld | Type | Verplicht | Opmerkingen |
|---|---|---|---|
| data | object[] | ja | |
| data[].id | string (uuid) | ja | |
| data[].customer_number | string | null | ja | |
| data[].customer_type | "company" | "private" | ja | |
| data[].salutation | "herr" | "frau" | null | ja | |
| data[].company_name | string | null | ja | |
| data[].first_name | string | null | ja | |
| data[].last_name | string | null | ja | |
| data[].display_name | string | ja | |
| data[].email | string | null | ja | |
| data[].phone | string | null | ja | |
| data[].mobile_phone | string | null | ja | |
| data[].fax | string | null | ja | |
| data[].address_street | string | null | ja | |
| data[].address_zip | string | null | ja | |
| data[].address_city | string | null | ja | |
| data[].tax_id | string | null | ja | |
| data[].notes | string | null | ja | |
| data[].is_archived | boolean | ja | |
| data[].created_at | string | ja | |
| data[].updated_at | string | null | ja | |
| pagination | object | ja | |
| pagination.limit | integer | ja | |
| pagination.offset | integer | ja | |
| pagination.total | integer | ja |