Skip to main content

Paginating responses

For endpoints that return a list of resources, the API often supports pagination to help manage large datasets. You can use the page and size query parameters to control the number of results returned per request and to navigate through the result sets.

  • page (integer): Specifies the page number to retrieve, starting from 0. The default value is 0.

    • Example: ?page=0 (retrieves the first page of results)
    • Example: ?page=2 (retrieves the third page of results)

  • size (integer): Specifies the maximum number of results to return per page. The default value is 20.

    • Example: ?size=50 (returns up to 50 results per page)

Here's an example of retrieving the second page of results with a page size of 25:

?page=1&size=25

Pagination parameters are typically available on most endpoints that return lists of resources.