Paginação

Alguns endpoints possuem paginação para limitar a quantidade de registros retornados em cada requisição. Para habilitar a paginação, envie o parâmetro paginate=S na requisição:

GET /api/subscribers?paginate=S

Quando o parâmetro paginate não for informado, ou for enviado com valor diferente de S, o endpoint seguirá o comportamento padrão, retornando a lista de registros diretamente, sem os campos links e meta.

ℹ️
Exceção de per_page
Por padrão, os endpoints retornam 20 itens por página. O endpoint GET /subscribers é uma exceção: por permitir um grande volume de dados, seu retorno paginado foi configurado para 500 itens por página.

Quando a paginação estiver habilitada, a resposta será retornada com a seguinte estrutura:

{
    "data": [],
    "links": {
        "first": ".../api/subscribers?paginate=S&page=1",
        "last": ".../api/subscribers?paginate=S&page=2",
        "prev": null,
        "next": ".../api/subscribers?paginate=S&page=2"
    },
    "meta": {
        "current_page": 1,
        "last_page": 2,
        "per_page": 500,
        "total": 510
    },
    "response": "success"
}

Campos da paginação:

Campo	Tipo	Descrição
`data`	array	Registros retornados na página atual.
`links.first`	string	URL da primeira página.
`links.last`	string	URL da última página.
`links.prev`	string\|null	URL da página anterior. Retorna null quando não houver.
`links.next`	string\|null	URL da próxima página. Retorna null quando não houver.
`meta.current_page`	integer	Número da página atual.
`meta.last_page`	integer	Número total de páginas.
`meta.per_page`	integer	Quantidade de registros por página.
`meta.total`	integer	Quantidade total de registros.
`response`	string	Indica o resultado da operação.

Para acessar uma página específica, utilize o parâmetro page:

GET /api/subscribers?paginate=S&page=2