For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Integration Example (PSA)
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Workflows Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
On this page
  • Combining Filtering and Ordering
Overview

Ordering

Was this page helpful?
Edit this page
Previous

Rate Limit

Next
Built with

The awork API supports ordering for most of the endpoints that return a list of entities. The ordering can be done by adding an orderby expression in the request url.

The following statement orders by the LastName property of the users in ascending order. If no ascending asc or descending desc order is defined, asc is chosen as a default.

1/users?orderby=LastName asc

You can also add multiple order statements by listing the properties separated with a , . Keep in mind that we do not allow spaces before or after the , .

The following url filters by LastName ascending first and then by FirstName descending.

1/users?orderby=LastName,FirstName desc

If you want to order by a nested property, you can do this by separating the Properties by / .

1/projects?orderby=ProjectStatus/Type desc

Combining Filtering and Ordering

You can combine filtering and ordering by adding the orderby parameter to the URL.

1/projects?filterby=duration le 6000 and duration gt 1000&orderby=duration desc