Listar pessoas do grupo econômico de um cliente

GET

/queries/clients/{clientId}/groups/economic

Lista as pessoas do grupo econômico do cliente informado em clientId, a partir do último resultado gravado. Entram só as pessoas com nível DIRECT; quando a mesma pessoa aparece mais de uma vez, vale uma ocorrência. Cada item traz taxId, name, type, level, relationshipName, isCurrentlyActive (verdadeiro quando a data de fim da relação é 9999-12-31), clientId (o id do cliente já cadastrado com o CPF ou CNPJ da pessoa, quando houver), isExpanded (verdadeiro só quando a pessoa já está no grupo cadastrado do cliente e esse grupo foi expandido), subType (ausente quando é DIRECTOR) e participation (percent, source e updatedAt), que só aparece quando há percentual de participação maior que zero. Cliente sem grupo gravado devolve items vazio. Requer autenticação via Bearer JWT ou header x-api-key. O cliente precisa pertencer à empresa do usuário: cliente inexistente devolve 404 (Cliente não encontrado), cliente de outra empresa devolve 401 (Acesso negado) e usuário inativo devolve 404 (Usuário não encontrado).

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

Pessoas do grupo econômico do cliente

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/queries/clients/7c9e6679-7425-40de-944b-e07fc1f90ae7/groups/economic' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "items": [
        {
            "taxId": "11144477735",
            "name": "SOCIO EXEMPLO",
            "type": "PARTNER",
            "level": "DIRECT",
            "clientId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
            "isExpanded": false,
            "participation": {
                "percent": 60,
                "source": "QUOD",
                "updatedAt": "2026-09-18T14:03:00.000Z"
            },
            "relationshipName": "SOCIO",
            "isCurrentlyActive": true
        },
        {
            "taxId": "22333444000155",
            "name": "HOLDING EXEMPLO LTDA",
            "type": "OWNERSHIP",
            "level": "DIRECT",
            "isExpanded": false,
            "relationshipName": "PROPRIETARIO",
            "isCurrentlyActive": false
        }
    ]
}

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

Página anterior

Listar pessoas do grupo familiar de um cliente

Próxima página

Listar débitos da empresa