Listing and Pagination

All API endpoints that return a list of items are paginated. To navigate between pages, there are 3 parameters:

  • limit: The number of items per page.
  • offset: The position of the item from which the page should be loaded. The initial item has position 0.
  • totalCount: The total number of items for the given filters.

For example, using limit 10 and offset 0 will return the first page with 10 items. Using limit 10 and offset 10 will bring up the second page, limit 10 and offset 20 the third page, and so on.

The limit must be a numeric value between 1 and 100. If omitted, the default value used is 10.

The attribute hasMore in the request response indicates whether there is another page to be fetched for the given filters.