List clients

GET

/v1/clients

Returns the clients (individuals or legal entities) registered under the authenticated company, with pagination and optional text search. Unlike the client listing scoped to a specific card, this endpoint returns the company's general client registry, regardless of whether each client is currently associated with an ongoing credit process.

The search parameter filters by name or document (CPF/CNPJ). Each returned item carries only basic identification data — for a specific client's full profile, use the single-client endpoint.

The ag-flow-id header is optional on these calls; when provided, it identifies an existing company flow (available from GET /v1/flows, Flow domain, or from the flow's URL in the AgFlow application) — omitting it does not block the call.

Requisição

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200Clients returned

application/json

Paginated list of the company's clients.

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