> ## 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 produtos cadastrados na sua conta

## Visão geral

Este endpoint retorna uma lista paginada dos produtos cadastrados na sua conta, com suporte a busca por nome e filtro por status.

## Endpoint

<CodeGroup>
  ```bash cURL theme={null}
  curl --request GET \
    --url "https://api.avanttifinance.com/v1/products?status=active&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/products?status=active&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/products"
  headers = {"Authorization": f"Bearer {access_token}"}
  params = {"status": "active", "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 do produto.
</ParamField>

<ParamField query="status" type="string">
  Filtra pelo status do produto: `active` ou `inactive`.
</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 produto.
</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": "prod_4f5e6d7c8b",
      "name": "Plano Premium",
      "price": 9990,
      "status": "active",
      "created_at": "2026-02-01T10:00:00Z"
    },
    {
      "id": "prod_9a8b7c6d5e",
      "name": "Consultoria Avulsa",
      "price": 25000,
      "status": "active",
      "created_at": "2025-12-15T14:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total_pages": 1,
    "total_items": 12
  }
}
```

## Próximos passos

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

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