Pagination

Most of the item collections are paginated. The parameter that controls the pagination is page, indicating the desired page.

Not using thepage attribute in the URL of the API request is similar to asking ?page=1

When requesting a paginated item collection, all responses will follow this schema (here we're simulating a GET on page 2):

{
    "count": 100, // Total elements count, among all pages
    "next": "https://page.url/?page=3",
    "previous": "https://page.url/?page=1",
    "results": [
        ...
    ]
}

count is the total number of elements that result from your request

next is the URL the request to send if you want to access results from the following page

previous is the URL the request to send if you want to access results from the page before

results are the elements from the current page. Elements are usually paginated by group of 20 or 100 in our API.

Last updated