Listar pessoas do grupo familiar de um cliente

GET

/queries/clients/{clientId}/groups/family

Lista as pessoas do grupo familiar do cliente informado em clientId, a partir do último resultado gravado. Cada item traz level, name, taxId e type (o grau de parentesco, como SPOUSE, SON ou BROTHER). Cliente sem grupo familiar 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 familiar 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/family' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "items": [
        {
            "level": "DIRECT",
            "name": "FAMILIAR EXEMPLO",
            "taxId": "11144477735",
            "type": "SPOUSE"
        },
        {
            "level": "DIRECT",
            "name": "FAMILIAR EXEMPLO FILHO",
            "taxId": "22255566677",
            "type": "SON"
        }
    ]
}

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

Página anterior

Visualizar Quod de um cliente

Próxima página

Listar pessoas do grupo econômico de um cliente