All get based endpoints that return a list of resources support cursor based pagination.
The results are returned in descending order by default, newest first.
Query Parameters
- maxResultsinteger
- Number of objects to return. Defaults to 20 if not set. Maximum supported value is 100.
- pageTokenstring
- The cursor for the page to request. The request returns the current and the next page token to enable iterating through the objects page by page.
Response
- objectstring, value is "collection"
- A string representing the object’s type. Objects of the same type share the same value.
- pageTokenstring
- The cursor of the returned page. This token can be used to request the same set of objects again.
- nextPageTokenstring
- The cursor for the next page. This token can be used to request the next set of objects. If missing, there are no further objects to return.
- maxResultsinteger
- The maximum number of objects returned for this call. Equals to the maxResults query parameter specified (or 20 if not specified).
- resultsinteger
- The actual number of objects returned for this call. This value is less than or equal to maxResults.
- dataarray
- The array of objects returned by the request.