Pagination
Learn how to paginate through lists.
To make API responses more compact, lists returned by the API are paginated. For lists, the response body includes:
limit
: The number of list items return per responseoffset
: The number of elements to skip (starting from 0)total
: The number of all available list itemsresults
: The array of list items (length of array equals the set limit)
Here is a sample response:
Using the limit
and offset
properties, you can paginate through the entire list by increasing the offset by the limit until you reach the total.