Sorting

You can apply sorting to our List API endpoints (e.g. GET /projects) to return a list of results in a specific order.

Current Support

We currently support sorting for Foundation, QuickBooks Online, Sage 100 Contractor, and Viewpoint Vista. To request other Source Systems, let us know at support@agaveapi.com.

To apply a sort, you will to include a JSON object specifying the field name and direction in the API request body:

curl --request GET https://api.agaveapi.com/projects \
     --header 'API-Version: 2021-11-21' \
     --header 'Client-Id: your_client_id' \
     --header 'Client-Secret: your_client_secret' \
     --header 'Account-Token: account_token' \
     --header 'Content-Type: application/json' \
     --data-raw '{
        "order_by": [
            {
                "field": "number", 
                "dir": "ASC"
            }
        ]
    }'