> ## Documentation Index
> Fetch the complete documentation index at: https://docs.avanttifinance.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar

> Liste e busque os clientes cadastrados na sua conta

## 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

<CodeGroup>
  ```bash cURL theme={null}
  curl --request GET \
    --url "https://api.avanttifinance.com/v1/customers?search=maria&page=1&limit=20" \
    --header "Authorization: Bearer SEU_TOKEN_DE_ACESSO"
  ```

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://api.avanttifinance.com/v1/customers?search=maria&page=1&limit=20",
    {
      method: "GET",
      headers: {
        Authorization: \`Bearer \${accessToken}\`,
      },
    }
  );

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  url = "https://api.avanttifinance.com/v1/customers"
  headers = {"Authorization": f"Bearer {access_token}"}
  params = {"search": "maria", "page": 1, "limit": 20}

  response = requests.get(url, headers=headers, params=params)
  print(response.json())
  ```
</CodeGroup>

## Parâmetros de consulta

<ParamField query="search" type="string">
  Busca por nome, e-mail ou documento (CPF/CNPJ) do cliente.
</ParamField>

<ParamField query="page" default="1" type="integer">
  Número da página de resultados.
</ParamField>

<ParamField query="limit" default="20" type="integer">
  Quantidade de itens por página. Máximo de 100.
</ParamField>

## Resposta

<ResponseField name="data" type="array">
  Lista de objetos de cliente.
</ResponseField>

<ResponseField name="pagination" type="object">
  Informações de paginação, incluindo página atual, total de páginas e total de registros.
</ResponseField>

### Exemplo de resposta

```json theme={null}
{
  "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

<CardGroup cols={2}>
  <Card title="Criar cliente" icon="user-plus" href="/criar">
    Cadastre um novo cliente.
  </Card>

  <Card title="Editar cliente" icon="pencil" href="/editar-1">
    Atualize os dados de um cliente existente.
  </Card>
</CardGroup>