# Paginação

Nossa API utiliza um sistema de paginação para controlar a quantidade de dados retornados em uma única resposta, facilitando a navegação e o uso eficiente dos recursos.

### Solicitação de rotas com Paginação

Ao realizar uma solicitação que suporte paginação, você pode passar o parâmetro `page` na query string para especificar qual página de resultados deseja obter. Por padrão, cada página contém 50 itens, mas esse valor pode ser diferente de acordo com a rota acessada.

#### Exemplo de Solicitação

```http
GET /api/v1/customers?page=1
```

**Resposta de Paginação**

A resposta incluirá uma estrutura de dados que fornece informações sobre a paginação, além dos dados solicitados:

```json
{
  "pagination": {
    "total_items": 14242,
    "showing_items": 50,
    "total_pages": 285,
    "current_page": 1,
    "previous_page": 1,
    "next_page": 2
  },
  "data": [
    ...
  ],
  "extra": {}
}
```

**Descrição dos Campos de Paginação**

* **total\_items**: O número total de itens disponíveis na coleção.
* **showing\_items**: O número de itens retornados na página atual.
* **total\_pages**: O número total de páginas disponíveis.
* **current\_page**: A página atual dos resultados.
* **previous\_page**: A página anterior (ou a primeira página se a atual for a primeira).
* **next\_page**: A próxima página (ou a última página se a atual for a última).

Se você solicitar uma página que exceda o número total de páginas disponíveis, a API retornará um erro informando que você atingiu o número máximo de páginas:

```json
{
  "id": "69e0fbc96642f8aefc9ddb75",
  "code": "VALIDATION_ERROR",
  "message": "Você já atingiu o número máximo de páginas! Número máximo: 285",
  "status_code": 422,
  "timestamp": "2024-08-06T13:13:22.139Z",
  "path": "/api/v1/error-path",
  "handled": true,
  "errors": []
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.altpaybr.com.br/documentation/api-operation/images-and-media.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.