Listar clientes de um grupo

GET

/groups/{groupId}/clients

Lista os clientes da empresa do usuário que pertencem ao grupo informado em groupId, em páginas de 60 itens, por ordem de nome. Sem allList igual a 1, a lista traz só os clientes cujo nome começa pela letra informada em letter; sem letter, traz só os que têm o nome começando por número ou sem nome. Com allList igual a 1, traz todos os clientes do grupo, sem aplicar letter nem text. text filtra por parte do nome ou do CPF/CNPJ. A resposta traz também alphabet, com uma chave para # (nomes iniciados por número ou sem nome) e uma para cada letra de A a Z: o valor é 1 quando há ao menos um cliente do grupo nessa letra, considerando text, e 0 quando não há; e item, com os dados do grupo. Grupo inexistente, ou sem clientes da empresa do usuário, não gera erro: items vem vazio. Existe também a versão v2 desta consulta, GET /v2/group/{groupId}/clients, com busca, ordenação e indicação de próxima página. 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 de Consulta

Parâmetros Header

Respostas

🟢200

application/json

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?page=1&letter=A&text=AGRO&allList=1' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "alphabet": {
        "#": 0,
        "A": 1,
        "B": 0,
        "C": 0,
        "D": 0,
        "E": 0,
        "F": 0,
        "G": 0,
        "H": 0,
        "I": 0,
        "J": 0,
        "K": 0,
        "L": 0,
        "M": 0,
        "N": 0,
        "O": 0,
        "P": 0,
        "Q": 0,
        "R": 0,
        "S": 0,
        "T": 0,
        "U": 0,
        "V": 0,
        "W": 0,
        "X": 0,
        "Y": 0,
        "Z": 0
    },
    "items": [
        {
            "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "name": "AGRO EXEMPLO S.A.",
            "groupId": "f1a2b3c4-0000-4000-8000-000000000901",
            "taxId": "11222333000181",
            "kind": "legal"
        }
    ],
    "item": [
        {
            "id": "f1a2b3c4-0000-4000-8000-000000000901",
            "kind": "group",
            "name": "Grupo Exemplo"
        }
    ]
}

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

Página anterior

Cadastrar grupo econômico expandido

Próxima página

Cadastrar cliente em um grupo