Listar clientes da empresa

GET

/v2/clients/

Lista os clientes e os grupos econômicos da empresa do usuário, 60 por página, sem os que foram removidos. kind diz o que é cada item: natural (pessoa física), legal (pessoa jurídica) ou group (grupo econômico). filter restringe o tipo (all, que é o padrão e traz os três, natural, legal ou groups), orderBy define a ordem (lastRegistered, os cadastrados mais recentemente primeiro, que é o padrão; crescentOrder e descendingOrder ordenam pelo nome) e search busca parte do nome, sem diferenciar maiúsculas nem acentos. Quando search tem só números (pontos, traços e barras são ignorados) ou tem o formato de um CNPJ com letras, a busca também casa parte do CPF ou CNPJ. Cada item traz _id, kind e name (a razão social, quando o cliente tem uma, ou o nome). Clientes trazem taxId e, quando há, spouse (name e taxId do cônjuge) e groupId; grupos não têm taxId e trazem isExpanded e, quando o grupo foi criado a partir de um cliente, clientIdFromOwner. nextPage é verdadeiro quando existe uma 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 Consulta

Parâmetros Header

Respostas

🟢200

application/json

Clientes e grupos da empresa

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/clients/?filter=all&orderBy=lastRegistered&search=Exemplo&page=1' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "items": [
        {
            "_id": "b4f0c1d-26a7-4e4c-91b9-a532f8e1d0c7",
            "kind": "legal",
            "name": "Empresa Exemplo Ltda",
            "taxId": "11222333000181",
            "groupId": null
        },
        {
            "_id": "0e7a3c58-91d4-4b6f-8c2a-5d3b9f1e6a22",
            "kind": "natural",
            "name": "Maria Exemplo da Silva",
            "taxId": "11144477735",
            "spouse": {
                "name": "João Exemplo da Silva",
                "taxId": "52998224725"
            },
            "groupId": "9d2e5a10-3b7c-4f48-a1d6-7c0e2b8f4d33"
        },
        {
            "_id": "9d2e5a10-3b7c-4f48-a1d6-7c0e2b8f4d33",
            "kind": "group",
            "name": "Grupo Exemplo",
            "isExpanded": true,
            "clientIdFromOwner": "0e7a3c58-91d4-4b6f-8c2a-5d3b9f1e6a22"
        }
    ],
    "nextPage": true
}

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

Página anterior

Cadastrar cliente

Próxima página

Solicitar relatório AgRisk