Skip to main content

Sorting lists

For endpoints that return lists of data (e.g. GET /banks or GET /payments), you can sort the data by certain fields, using the format specification below.

Sort order#

ASC#

  • Numerical from lowest first
  • Text in alphabetical order
  • Dates from earliest first

DESC#

  • Numerical from highest first
  • Text in reverse alphabetical order
  • Dates from latest first

To sort by a particular field#

  • Specify the order parameter and the field name in square brackets and the sort order
/accounts?order[createdAt]=ASC

To sort by multiple fields#

  • specify the order parameter more than once and your data will be sorted in the same order as the parameters
?order[createdAt]=ASC&order[name]=DESC