Ordering

Structure your API response in a desired order

Use the OrderBy Parameter to Order API Response Output

Ordering lets you sort the results of each request, where applicable, by specifying the order of records in the response payload. To do this, use OrderBy as a query parameter. This way, you get only relevant data, already sorted.

How to Sort the Response with the OrderBy Parameter

The query has the following structure: OrderBy={value}, where value is the name of the property to sort by.

To sort the output, add OrderBy for the property it should be ordered by. For example:
https://app.upswot.com/admin/api/v1/normalized-data/companies?OrderBy=name

The response payload is returned in ascending order by default. To get the same list in descending order, add &Desc=true. For example:

https://app.upswot.com/admin/api/v1/normalized-data/companies?OrderBy=name&Desc=true

📘

You cannot apply OrderBy to multiple properties — doing so returns a 400 error.