API endpoints which are expected to return large numbers of results will use pagination to return a limited number of items at a time.
We use two parameters to provide pagination functionality:
limit controls the maximum number of results that an endpoint can return. The default value for
limit is documented on each specific endpoint.
offset controls how many results to skip over in your results. By default, it is always
When querying all results, your initial call should pass an offset of
0. If the number of results you receive is less than the limit you passed (or the default limit if none was passed explicitly), you have reached the end of the result set and can end pagination. Otherwise, make another API call with
offset set to
previousOffset + limit to get the next page. Repeat until you are at the end of the list.