Pagination

If a request returns multiple items, they will be paginated to 25 items per page. The result then includes pagination information in addition to the data array:

meta contains the total number of pages and the current page. links contains several hyperlinks:

Name	Description
`self`	The link to the current page. It should match the requested URL with added `?page[number]` parameter.
`first`	The link to the first page of results.
`prev`	The link to the previous page or `null` if the current page is the first page.
`next`	The link to the next page or `null` it the current page is the last page.
`last`	The link to the last page of results.

If all items fit into a single page, total_pages will be 1, prev and next will both be null, and self, first and last will all refer to the first page.

Page numbering is 1-based. Omitting the ?page[number] parameter will return the first page.

Traversing with pagination

Since constructing your own URLs is error prone, you should use the provided links if possible.

These code examples are purposely kept simple. They should give you an idea of the general structure. The code is neither production ready nor idiomatic.

Traversing with pagination#

Traversing with pagination