Detalhar cliente

View as Markdown
Consulta o cadastro, os contatos e o resumo comercial de um cliente. **Autenticação:** Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário. ### Parâmetros de caminho | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `id` | integer | Sim | ID 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`: | 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. | | `contacts` | array<object> | Contatos do cliente. | | `contacts[].id` | integer | ID para usar em contactId. | | `contacts[].name` | string | Nome. | | `contacts[].email` | string | E-mail. | | `contacts[].phone` | string | Telefone. | | `contacts[].position` | string | Cargo. | | `contacts[].main` | integer | 1 indica contato principal. | | `contacts[].active` | integer | 1 indica contato ativo. | ```json { "data": { "id": 101, "name": "Empresa Exemplo", "sponsor": "Ana Silva", "email": "[email protected]", "phone": "+5511999990000", "national_id": "11222333000181", "contacts": [ { "id": 201, "name": "Ana Silva", "email": "[email protected]", "phone": "+5511999990000", "position": "Compras", "main": 1, "active": 1 } ], "budget_count": 1, "budget_value_total": 1500, "activity_count": 1 } } ``` ### Erros específicos | HTTP | Código | Situação | |---|---|---| | 404 | `CLIENT_NOT_FOUND` | Client not found. | 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.

Path parameters

idstringRequired
ID do cliente.

Response

OK
dataobject

Errors

404
Not Found Error