Pagination

A collection potentially consists of rather large amounts of resources. To cope with that, the result set can be paginated.

These limitations apply

  • The default page size is 100.
  • The maximum page size is 200.

Paging a collection

Attribute Notes
page[size]=200 This sets the page size to 200.
page[number]=2 This selects page number 2.
stats[total]=count This returns the total number of records. Based on that you can calulate the number of pages and act accordingly.

Example

Having a theoretical resource called document and we want to have a page size of 10 and select page 2, it should also returns the total number of records. The result would look like this:

GET /api/v1/documents?page[size]=10&page[number]=2&stats[total]=count