Lister les clients
Par pages ; clients archivés seulement avec include_archived=true.
Scope requis : customers:read.
Scope : customers:read
| Champ | Type | Obligatoire | Remarques |
|---|---|---|---|
| limit(query) | integer | non | Par défaut : 50 · min. 1 · max. 100 |
| offset(query) | integer | non | Par défaut : 0 · min. 0 |
| include_archived(query) | "true" | "false" | non | Par défaut : "false" |
Réponses
- 200 Liste des clients.
- 400 Saisie non valide.
- 401 Clé API absente, inconnue ou révoquée. Corps vide.
- 403 Il manque à la clé le scope requis.
- 429 Trop de requêtes pour cette clé.
- 500 Erreur interne.
| Champ | Type | Obligatoire | Remarques |
|---|---|---|---|
| data | object[] | oui | |
| data[].id | string (uuid) | oui | |
| data[].customer_number | string | null | oui | |
| data[].customer_type | "company" | "private" | oui | |
| data[].salutation | "herr" | "frau" | null | oui | |
| data[].company_name | string | null | oui | |
| data[].first_name | string | null | oui | |
| data[].last_name | string | null | oui | |
| data[].display_name | string | oui | |
| data[].email | string | null | oui | |
| data[].phone | string | null | oui | |
| data[].mobile_phone | string | null | oui | |
| data[].fax | string | null | oui | |
| data[].address_street | string | null | oui | |
| data[].address_zip | string | null | oui | |
| data[].address_city | string | null | oui | |
| data[].tax_id | string | null | oui | |
| data[].notes | string | null | oui | |
| data[].is_archived | boolean | oui | |
| data[].created_at | string | oui | |
| data[].updated_at | string | null | oui | |
| pagination | object | oui | |
| pagination.limit | integer | oui | |
| pagination.offset | integer | oui | |
| pagination.total | integer | oui |