Métodos identificados na documentação poderão retornar uma lista parcial de resultados caso ultrapassem o limite de registros por página. Nestes casos, na reposta serão informados os cabeçalhos Total
, Per-Page
e Link
que auxiliarão na construção da requisição das próximas páginas:
Total
Total de registros em todas as páginas
Per-Page
Número máximo de registros por página
Link
URLs relacionadas (Hypermedia)
Exemplo de cabeçalho de resposta:
Total: 72
Per-Page: 25
Link: <https://app.vindi.com.br/api/v1/customers?page=3>; rel="last",<https://app.vindi.com.br/api/v1/customers?page=2>; rel="next"\`
Recomendamos a utilização dos registros contidos no cabeçalho Link
para efetuar a paginação. Também é possível informar a query string per_page
para alterar o número de registros por página, limitado em 50 registros:
curl <https://app.vindi.com.br/api/v1/customers?per_page=50>
-H Content-Type:application/json
-u API_KEY: