Pagination

How list endpoints page their results.

Every list endpoint takes two query parameters and returns a pagination block.

ParameterMeaning
pageWhich page to return, starting at 1
limitHow many records per page. Maximum 100. The default is 5 or 10, depending on the endpoint
"pagination": {
  "total": 128,
  "pages": 13,
  "currentPage": 1,
  "limit": 10,
  "hasNext": true,
  "hasPrev": false
}

Keep requesting the next page while hasNext is true. Where an endpoint offers filters, such as status, order type or a date range, filter on the server instead of paging through everything.