Skip to main content

Sorting

How to Use Sorting​

One list can be reordered: GET /v3/customers. Every other list, on v3 and on v2, comes back in its own fixed order and takes no sort parameter.

GET /v3/customers takes a sort query parameter:

  • A comma-separated list of fields, the most significant first.
  • A - before a field sorts it in descending order; without it, ascending.
  • At most three fields, each named once.
  • Without sort, customers come newest first (-created_at).

Example of a Sorting Request:​

  • Newest first: GET /v3/customers?sort=-created_at
  • By name, then newest first among equal names: GET /v3/customers?sort=name,-created_at

Supported Fields​

FieldSorts by
nameThe customer's name.
emailThe customer's email.
customer_typeindividual or business.
statusThe customer's status.
created_atWhen the customer was created.

A field outside this list, a field named twice, or more than three fields answers 400 with "message": "invalid_sort".

There is no separate order parameter: the direction is the - prefix.

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!