Skip to main content

​
Visão geral

Este endpoint retorna uma lista paginada dos clientes cadastrados na sua conta, com suporte a busca por nome, e-mail ou documento.

​
Endpoint

curl --request GET \
  --url "https://api.avanttifinance.com/v1/customers?search=maria&page=1&limit=20" \
  --header "Authorization: Bearer SEU_TOKEN_DE_ACESSO"

​
Parâmetros de consulta

​
search
string
Busca por nome, e-mail ou documento (CPF/CNPJ) do cliente.
​
page
integer
default:"1"
Número da página de resultados.
​
limit
integer
default:"20"
Quantidade de itens por página. Máximo de 100.

​
Resposta

​
data
array
Lista de objetos de cliente.
​
pagination
object
Informações de paginação, incluindo página atual, total de páginas e total de registros.

​
Exemplo de resposta

{
  "data": [
    {
      "id": "cus_3a8f9c1b2d",
      "name": "Maria da Silva",
      "email": "maria@exemplo.com",
      "document": "123.456.789-00",
      "created_at": "2026-01-15T09:00:00Z"
    },
    {
      "id": "cus_8e7d6c5b4a",
      "name": "João Pereira",
      "email": "joao@exemplo.com",
      "document": "987.654.321-00",
      "created_at": "2025-11-02T13:20:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total_pages": 5,
    "total_items": 96
  }
}

​
Próximos passos

Criar cliente

Cadastre um novo cliente.

Editar cliente

Atualize os dados de um cliente existente.