#
Filtering & Sorting
#
Filtering
Endpoints that return an enumeration of items and are marked with Paginated can usually be filtered by adding query parameters to the request body. The following query parameters are supported:
Note
- The specific fields that are searched for the
search
parameter depend on the endpoint. Further information can be found in the documentation for the specific endpoint. - The specific fields that can be used for the
filter
parameter depend on the endpoint. Further information can be found in the documentation for the specific endpoint. - The keys in the
filter
parameter must be unique. Using the same key multiple times may lead to unexpected results. - The keys in the
filter
parameter are case-sensitive. - The values in the
filter
must always be a string.
#
Sorting
Endpoints that return an enumeration of items and are marked with Paginated can usually be sorted by adding query parameters to the request body. The following query parameters are supported:
The direction can be either asc
or desc
.
Note
- The specific fields that can be used for the
sort
parameter depend on the endpoint. Further information can be found in the documentation for the specific endpoint. - The keys in the
sort
parameter must be unique. Using the same key multiple times may lead to unexpected results. - The keys in the
sort
parameter are case-sensitive.