Consultar quantide de clientes por classificação

GET

/clients/details

Devolve os totais de clientes da empresa do usuário, por tipo: legalLength (pessoas jurídicas), naturalLength (pessoas físicas) e groupLength (grupos). Clientes e grupos removidos não entram na contagem. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Respostas

🟢200

application/json

Totais de clientes e grupos

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/clients/details' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "legalLength": 12,
    "naturalLength": 30,
    "groupLength": 3
}

Modificado em 2026-10-13 13:24:39

Página anterior

Solicitar relatório AgRisk

Próxima página

Remover cliente