Skip to content

Pagination Support

Andres Freyria edited this page Jul 22, 2014 · 2 revisions

Since collections can grow indefinitely, all collection representations have support for pagination, as sending the complete data set would be unwieldy.

Pagination consists of the following:

  • A count property: All collections return the total number of items available, given the query parameters supplied (if any, if supported).
  • previous and next link relations: If there are more pages available, relative to the requested page, these links will be present to navigate between the pages.
  • per_page URL parameter: By default, 20 results will be returned per page. This value is configurable by sending per_page as a URL parameter, with the acceptable values being: [10, 20, 30, 60].