Skip to navigation

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):

CampoTipoDescrição
idintegerID do cliente.
namestringNome.
emailstringE-mail.
phonestringTelefone.
national_idstringDocumento.
sponsorstringContato principal.
addressobjectEndereço.
statusstringSituação do cadastro.
metadataobject ou arrayValores personalizados, conforme configuração.
{
"data": [
{
"id": 101,
"name": "Empresa Exemplo",
"sponsor": "Ana Silva",
"email": "contato@example.com",
"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

200 — Sucesso — exemplo ilustrativo

datalist of objectsOptional