Consultar totais de clientes de um grupo

GET

/groups/{groupId}/clients/details

Devolve os totais de clientes do grupo informado em groupId, entre os clientes da empresa do usuário, por tipo: legalLength (pessoas jurídicas) e naturalLength (pessoas físicas). Clientes removidos não entram na contagem. Grupo inexistente, ou sem clientes da empresa do usuário, não gera erro: os dois totais vêm 0. 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 de Caminho

Parâmetros Header

Respostas

🟢200

application/json

Totais de clientes do grupo

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/groups/f1a2b3c4-0000-4000-8000-000000000901/clients/details' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "legalLength": 2,
    "naturalLength": 1
}

Modificado em 2026-10-13 09:47:06

Página anterior

Cadastrar cliente em um grupo

Próxima página

Renomear grupo