Kunden auflisten
Seitenweise, archivierte Kunden nur mit include_archived=true.
Benötigter Scope: customers:read.
Scope: customers:read
| Feld | Typ | Pflicht | Hinweise |
|---|---|---|---|
| limit(Query) | integer | nein | Standard: 50 · min. 1 · max. 100 |
| offset(Query) | integer | nein | Standard: 0 · min. 0 |
| include_archived(Query) | "true" | "false" | nein | Standard: "false" |
Antworten
- 200 Kundenliste.
- 400 Ungültige Eingabe.
- 401 API-Schlüssel fehlt, ist unbekannt oder widerrufen. Leerer Rumpf.
- 403 Dem Schlüssel fehlt der benötigte Scope.
- 429 Zu viele Anfragen für diesen Schlüssel.
- 500 Interner Fehler.
| Feld | Typ | Pflicht | Hinweise |
|---|---|---|---|
| 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 |