Pagination
Learn how to paginate API responses using page-based or offset-based methods for both GET and POST requests
Responses that return a list of items are paginated. We offer two different pagination strategies:
- Page-based: This method allows you to navigate through paginated data by specifying the
pageandlimitparameters. Thepageparameter indicates the page number you wish to retrieve, while thelimitparameter specifies the maximum number of items to return per page. For POST requests, include these parameters in the request body. For GET requests, use them as query parameters. - Offset-based: This method allows you to navigate through paginated data by specifying the
offsetandlimitparameters. Theoffsetparameter indicates the starting point within the collection of results, while thelimitparameter specifies the maximum number of items to return. For POST requests, include these parameters in the request body. For GET requests, use them as query parameters. Some of these endpoints also support theinclude_total_resultsbody or query parameter. If you set it tofalse, the responses will be faster, and the fieldtotal_resultsof the response will benull.
How is this guide?
Last updated on
