Listar clientes

GET

/v1/clients

Retorna os clientes (pessoas físicas ou jurídicas) cadastrados na empresa autenticada, com paginação e busca textual opcional. Diferente da listagem de clientes vinculada a um card específico, este endpoint devolve o cadastro geral de clientes da empresa, independentemente de estarem ou não associados a algum processo de crédito em andamento.

O parâmetro search filtra por nome ou documento (CPF/CNPJ). Cada item retornado traz apenas os dados básicos de identificação — para o perfil completo de um cliente específico, use o endpoint de obtenção individual.

O cabeçalho ag-flow-id é opcional nestas chamadas; quando enviado, identifica um flow existente da empresa (disponível em GET /v1/flows, domínio Fluxo, ou na URL do flow na aplicação AgFlow) — omiti-lo não impede a chamada.

Requisição

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200Clientes retornados

application/json

Lista paginada de clientes da empresa.

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/clients?search=undefined&limit=undefined&offset=undefined' \
--header 'ag-flow-id;'

Response Example

{
    "items": [
        {
            "id": "string",
            "taxId": "string",
            "name": "string",
            "kind": "natural",
            "createdAt": "string"
        }
    ],
    "total": 0
}

Modificado em 2026-07-29 13:10:05