Lists & paging

All API methods that return a list of items in the response accept the following paging parameters:

NameTypeUseDescription
pageintegeroptionalPage number - defaults to 1
pageSizeintegeroptionalNumber of items to be returned per page. Defaults to 10. Maximum page size is 50

Paging information will also be included in the response as per the format below:

{
  "page": 1,
  "pageSize": 10,
  "totalItems": 24365
}
<page>1</page>
<itemsPerPage>10</itemsPerPage>
<totalItems>24365</totalItems>

The value of totalItems is the maximum number of results.
There will sometimes be fewer results available than the totalItems count. This is more noticeable when paging through a large result set. As you advance through the pages the totalItems count may drop.