How to Query
The listing endpoint allows you to sort, filter, and limit the amount of data returned. Below are the guidelines for effectively utilizing these features
Query list request/response
Sorting
To sort data in a specified manner, you should add to your request:
_orderBy[fieldName]=asc
- Ascends byfieldName
._orderBy[fieldName]=desc
- Descends byfieldName
.
Note: Not all visible fields are sortable. If sorting is not specified in the request, data may be returned in any order.
Filtering
For data filtering, you can use the parameter in the following format:
fieldName[OPERATOR]=value
allows for operation-based filtering.fieldName=value
is equivalent tofieldName[eq]=value
, applying an equality filter.
Filters can be combined as follows:
fieldName[OPERATOR]=value&fieldName2[OPERATOR]=value2
, with the filters connected by the logical AND operator.
This structure enables precise control over the data you retrieve, ensuring that the endpoint returns only the information relevant to your needs.
Operators
Operator | Description | Data Types |
---|---|---|
| Equality (case sensitive) | All |
| Substring occurrence (anywhere in the string) (case-insensitive) | Text |
| Checks if the value is defined (empty string counts as defined) | All |
| Checks if the value is undefined (empty string counts as defined) | All |
| Less than | Numeric/Datetime |
| Less than or equal | Numeric/Datetime |
| Greater than | Numeric/Datetime |
| Greater than or equal | Numeric/Datetime |
| Check in array | Some array fields |
Last updated