Pagination

A collection potentially consists of a large amount of resources. To cope with that the result set can be paginated.

These limitations apply

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

Paging a collection

Attribute Notes
page[size]=200 Sets the page size to 200.
page[number]=2 Selects page number 2.
stats[total]=count Returns the total number of records, based on which you can calculate the total number of pages.

Example

Assume the hypothetical resource “document” and you want a page size of 10 and select page 2, the request would look like this:

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

Note that the answer will also include the total number of records.