Paging
Endpoints that return a list response are paged. Paged endpoints have a standard set of request and response properties. Request properties follow a limit/offset practice and allow sort customization. A sort order is required for consistent paging results. Responses contain properties that indicate the page and offer URLs for the previous and next pages.
Some endpoints have different sort options, which are noted with the endpoint documentation.
Paging parameters
limit |
(integer) Set a maximum size for the result set. |
offset |
(integer) Set the starting point for a page of results. |
sortBy |
Sets the sort key for the result set. |
sortDirection |
Sets the sort direction for the result set. |
Paging response properties
totalCount |
The total number of results available. This may be smaller than the requested page size. |
limit |
(integer) The page size that was requested. The result set may be smaller than this value, if there is not enough data to fill the page. The limit value in the response will be different if the requested value was greater than the maximum allowed. |
offset |
(integer) The starting point for the response page. |
results |
An array containing the results that were requested. This attribute is described in detail with each request below. |
nextPage |
A URL that will fetch the next page of results. If no more pages are available, this attribute will not be present. |
previousPage |
A URL that will fetch the previous page of results. If no previous page is available, this attribute will not be present. |