Page Size
Page size is negotiated through the
(int) limit (min is zero, max may depend on API endpoint), and as a result dictates the maximum number of items per page the server will respond with.Page Cursor
(string) page is the continuation token (i.e. cursor) obtained during a previous request allowing you to retrieve the next page or the previous page.You may also provide a number as (int) page (starting at page 1) if you really need indexed pages, but this is not recommended.itemscontains the resources in the given page;totalCountindicates how many resources exist across all pages (while applying the query filters) - the server will only return this count when requesting it through?include=totalCount;linkscontains the links to the previous and next pages,nullwhen there is none. A link may lead to an empty page, such asprevon the first page ornexton a full last page: stop paging whennextisnull. The server only returnslinkswhen requested through?include=links. Each link has:href: the URL of the page, to follow as is;cursor: thepagequery parameter ofhref. Pass it aspagewhen you call the operation rather than a URL, e.g. through a generated SDK, with the same other query parameters (filters,limit,include) as the current request.
About includes
Learn more about how to include links and/or related resources.
Sorting results
Learn more about how to sort the items of a collection.