Pagination and Sorting

Pagination

For endpoints that return List objects, we support paging via the page and page_size parameters.

We do not explicitly include pagination metadata in the API and expect clients to use the next and prev links to navigate forward and backward through the result set.

{
  "object":"List",
  "results":[],
  "links":{
    "self":"https://api.sandbox.routable.com/v1/companies",
    "next":"https://api.sandbox.routable.com/v1/companies?page=2&page_size=10",
    "prev":null
  }
}

Sorting

For list endpoints that support sorting, such as List Payables , a sort parameter can be provided to the API. This parameter supports a single field name in the resource. You may specify the field name to sort in ascending order by that field (eg. sort="created_at") or in descending order by prefixing the field name with a -, for example, sort="-created_at".

🚧

🚧 Consider Sort Order Undefined

At this time, please consider our sort order for list calls to be undefined unless specified in the API reference guide. We are working towards standardizing these and will be specifying them at a future date.


What’s Next
Did this page help you?