Pagination

When you retrieve a list of resources from the server with a GET request, the results are paginated with 30 results per page by default.

The payload received is the following:

"your-object": {
  // here the data you are retrieving...
}
"links": {
    "first": "https://api.{staging?}.saqara.com/api/your-route?page=1",
    "last": "https://api.{staging?}.saqara.com/api/your-route?page=4",
    "prev": "https://api.{staging?}.saqara.com/api/your-route?page=1",
    "next": "https://api.{staging?}.saqara.com/api/your-route?page=3"
},
"meta": {
    "current_page": 2,
    "from": 31,
    "path": "https://api.{staging?}.saqara.com/api/your-route",
    "per_page": 30,
    "to": 60
}
key Description
links.first The URL of the first page.
links.last The URL of the last page.
links.prev The URL of the previous page.
links.next The URL of the next page.
meta.current_page The index of the current page where 1 is the first page.
meta.from The index of the first resource in the current page.
meta.path The URL of the resources without pagination.
meta.per_page Number of occurrence per page.
meta.to The index of the last resource in the current page.