#
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
searchparameter 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
filterparameter depend on the endpoint. Further information can be found in the documentation for the specific endpoint. - The keys in the
filterparameter must be unique. Using the same key multiple times may lead to unexpected results. - The keys in the
filterparameter are case-sensitive. - The values in the
filtermust 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
sortparameter depend on the endpoint. Further information can be found in the documentation for the specific endpoint. - The keys in the
sortparameter must be unique. Using the same key multiple times may lead to unexpected results. - The keys in the
sortparameter are case-sensitive.