Pagination

All endpoints with pagination enabled implement same pagination scheme.

Paginated response will contain special pagination attributes. Example:

Code
{
    "count": 1023,
    "next": "https://api.example.org/accounts/?page=5",
    "previous": "https://api.example.org/accounts/?page=3",
    "results": [
       ...
    ],
}

You can customize pagination settings using query parameters:

page_size - set the number of items per page (default is 100)

page - set the page number to get in response (default is 1)

Paginated responses are sorted by id value.

Exceptions. Recipe and recipe template listings are paginated differently. In both v3 and v3.1, page_size defaults to 20 for them, and the results are not sorted by id: templates come back in catalogue order, recipes ordered by updated_at descending. The v3.1 accounts endpoint keeps the default of 100 and sorts by id. The maximum page_size everywhere is 100 - a larger value is rejected with a 400 instead of being silently capped, and asking for a page past the end of the list is a 400 as well.