Listar clientes
Por páginas; clientes arquivados só com include_archived=true.
Scope necessário: customers:read.
Scope: customers:read
| Campo | Tipo | Obrigatório | Notas |
|---|---|---|---|
| limit(query) | integer | não | Predefinição: 50 · mín. 1 · máx. 100 |
| offset(query) | integer | não | Predefinição: 0 · mín. 0 |
| include_archived(query) | "true" | "false" | não | Predefinição: "false" |
Respostas
- 200 Lista de clientes.
- 400 Entrada inválida.
- 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
- 403 Falta à chave o scope necessário.
- 429 Demasiados pedidos para esta chave.
- 500 Erro interno.
| Campo | Tipo | Obrigatório | Notas |
|---|---|---|---|
| data | object[] | sim | |
| data[].id | string (uuid) | sim | |
| data[].customer_number | string | null | sim | |
| data[].customer_type | "company" | "private" | sim | |
| data[].salutation | "herr" | "frau" | null | sim | |
| data[].company_name | string | null | sim | |
| data[].first_name | string | null | sim | |
| data[].last_name | string | null | sim | |
| data[].display_name | string | sim | |
| data[].email | string | null | sim | |
| data[].phone | string | null | sim | |
| data[].mobile_phone | string | null | sim | |
| data[].fax | string | null | sim | |
| data[].address_street | string | null | sim | |
| data[].address_zip | string | null | sim | |
| data[].address_city | string | null | sim | |
| data[].tax_id | string | null | sim | |
| data[].notes | string | null | sim | |
| data[].is_archived | boolean | sim | |
| data[].created_at | string | sim | |
| data[].updated_at | string | null | sim | |
| pagination | object | sim | |
| pagination.limit | integer | sim | |
| pagination.offset | integer | sim | |
| pagination.total | integer | sim |