Pagination

Overview

For endpoints that list all items in a resource collection, you can optionally paginate the response using two request parameters:

  • size: the maximum number of items to return. Accepts integers from 0 to 500. Defaults to 100.
  • index: the starting point within the list of items. Accepts integers 0 and greater. Defaults to 0.

API responses are returned in reverse chronological order, meaning the newest items will appear at the top of the response. If no pagination parameters are supplied, Deliver will default to returning the most recently created 100 items.

Request Examples

The below request has a size of 10 and an index of 0, meaning the API would return transfers 1-10.

https://api-sandbox.orum.io/deliver/transfers?size=10&index=0

To return the next 10 transfers, make a request with a size of 10 and an index of 1. This would return transfers 11-20.

https://api-sandbox.orum.io/deliver/transfers?size=10&index=1