Most "list" endpoints (employees, tasks, case changes, payrun periods, etc. - see the Ason Feature Tree for the endpoints behind each feature) accept the same set of query parameters for filtering, sorting and paging. They follow OData syntax.
Parameters
| Parameter | What it does |
|---|---|
filter | OData filter expression, e.g. status eq 'Active' |
orderBy | OData sort expression, e.g. firstName asc |
select | Only return the listed fields |
top | Max number of items to return |
skip | Number of items to skip (for paging) |
result | Items (default), Count, or ItemsWithCount |
status | Shorthand for Active / Inactive objects |
Filtering
filter takes a standard OData boolean expression:
- Comparison:
eq,ne,gt,ge,lt,le - Logical:
and,or,not - String functions:
contains(...),startswith(...)
Code
Sorting
orderBy takes one or more fields, comma-separated, each with an optional asc/desc:
Code
Paging
Combine top and skip to page through results. Use result=ItemsWithCount to get the total count alongside the page of items - needed to render a page count in a UI.
Code
Where this is used
Every "List ..." endpoint listed in the Ason Feature Tree accepts these parameters. See the API Reference for the exact parameters available on a specific endpoint - not every list supports every parameter.
Last modified on