Each collection always has a meta
and links
key with information about the paginator.
#Meta
meta
contains the complete information of the paginator, such as the current page or the number of results.
#Links
links
contains the direct URLs for navigating through the result set (first
, last
, prev
and next
).
#Parameters
By default, 25 objects are returned per page.
You can request a different pagination limit or force pagination by appending ?per_page
to the request
with the number of items you would like per page. For instance, to show only two results per page, you could
add ?per_page=2
to the end of your query. The maximum number of results per page is 100.
You can use the URLs listed under links
to browse through the pages or directly select a page using
the ?page
query string parameter. With ?page=4
you can e. g. go directly to page 4.
#Example
GET /production-methods?per_page=2&page=2 HTTP/1.1
{
"data": [
{
"id": 3,
"collection_name": "dtg",
"handle": "dtg",
"name": "Digital print",
"description": "Digital print",
"is_digitizable": false,
"created_at": "2022-04-28T14:30:56+00:00",
"updated_at": "2022-04-28T14:30:56+00:00"
},
{
"id": 4,
"collection_name": "embroidery",
"handle": "embroidery",
"name": "Embroider",
"description": "Embroider",
"is_digitizable": true,
"created_at": "2022-04-28T14:30:56+00:00",
"updated_at": "2022-04-28T14:30:56+00:00"
},
],
"links": {
"first": "https://api.smake.io/v2/apps/1/production-methods?per_page=2&page=1",
"last": null,
"prev": "https://api.smake.io/v2/apps/1/production-methods?per_page=2&page=1",
"next": null
},
"meta": {
"current_page": 2,
"from": 3,
"path": "https://api.smake.io/v2/apps/1/production-methods",
"per_page": 2,
"to": 4
}
}