Pagination

List endpoints return results one page at a time.

• $maxpagesize: the maximum number of items to return in a page. The service applies a default and a maximum; requests above the maximum are clamped.

• $next: an opaque continuation token identifying the next page. You do not normally set it yourself; it is already applied to the @nextLink in the previous response.

A paginated response includes a @nextLink, an absolute URL for the next page of results with the $next cursor already applied. It also carries the filter, sort, and page-size state from the original request, so follow it as-is rather than rebuilding the query. When @nextLink is absent, there are no more pages.

GET https://api.app.wdesk.com/controls?$maxpagesize=100
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": [ /* ...controls... */ ],
  "@nextLink": "https://api.app.wdesk.com/controls?$maxpagesize=100&$next=b3BhcXVlLW5leHQtcGFnZS10b2tlbg=="
}

To page through the full collection, keep following the returned @nextLink until the response no longer includes one.

Note

Batch endpoints (POST /{resource}/batchRetrieval) are not paginated. The caller holds the id set and chunks it into requests of up to 250 ids each.