Listar clientes
Lista os clientes acessíveis ao usuário autenticado.
**Autenticação:** Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário.
Informações de contato também podem estar agrupadas em config. Use GET /clients/{id} para consultar contatos e o histórico comercial do cliente.
### Resposta
HTTP **200**. Os exemplos usam dados fictícios e mostram os campos principais; outros campos podem acompanhar a resposta. Campos sem valor podem ser nulos.
Campos principais de `data` (cada elemento da lista):
| Campo | Tipo | Descrição |
|---|---|---|
| `id` | integer | ID do cliente. |
| `name` | string | Nome. |
| `email` | string | E-mail. |
| `phone` | string | Telefone. |
| `national_id` | string | Documento. |
| `sponsor` | string | Contato principal. |
| `address` | object | Endereço. |
| `status` | string | Situação do cadastro. |
| `metadata` | object ou array | Valores personalizados, conforme configuração. |
```json
{
"data": [
{
"id": 101,
"name": "Empresa Exemplo",
"sponsor": "Ana Silva",
"email": "[email protected]",
"phone": "+5511999990000",
"national_id": "11222333000181"
}
]
}
```
Consulte a introdução da collection para o formato de erros e a configuração das variáveis.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Response
OK
data