Listings
All listings throughout the API follow the same format for pagination, ordering, filtering and response structure.
| Name | Type | Required / Optional | Description | Restrictions |
|---|---|---|---|---|
| limit | Integer | Optional | The number of entities to request, defaults to 10. A count only query can be done with a limit of 0. |
|
| offset | Integer | Optional | The offset to start at |
|
| order | String | Optional | The field to use for ordering, default differs per listing. When prefixed with a minus sign ("-") ordering will be descending. The order parameter can be specified multiple times to order by multiple fields, the order parameters are processed in the order they appear in the URL. |
|
| total | Boolean | Optional | The default is to return a total count of all matched entities in the result, if this is not necessary it can be omitted with this flag. This will result in a speed improvement | |
| q | String | Optional | Generic search over all fields |
|
| fields | String | Optional | Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included. |
|
| export | Boolean | Optional | When true all records will be returned. Cannot be used in combination with "limit" and/or "offset" parameters. For exports the default field selection consists only of identifying fields, to add other fields use the "fields" parameter |
Filtering is used to select a subset of entities. The specific fields that support filtering differ per listing. Specifying multiple filters on the same field is supported.
Filter parameters are structured so that the key contains the field to filter and the operator separated by a colon (":") and the value is the value to apply the operator to. The colon and operator are optional and will default to the equal ("eq") operator, the allowed operator types differ per field type.
| Operator | Description | String | List<String> | Date | Integer | List<Integer> | Enum | List<Enum> | Boolean |
|---|---|---|---|---|---|---|---|---|---|
| eq | Equal to | ||||||||
| ne | Not equal to | ||||||||
| like | Matches wildcard pattern, wildcard sign is percentage ("%") | ||||||||
| not_like | Does not match wildcard pattern, wildcard sign is percentage ("%") | ||||||||
| gt | Greater then | ||||||||
| lt | Less then | ||||||||
| gte | Greater then or equal to | ||||||||
| lte | Less then or equal to | ||||||||
| null | Does not have a value | ||||||||
| not_null | Has a value | ||||||||
| in | Is contained in list, list items are separated by comma (",") | ||||||||
| not_in | Is not contained in list, list items are separated by comma (",") |
- 200 OKHTTP Status
- application/jsonContent-Type
| Name | Type | Required / Optional | Description | Restrictions |
|---|---|---|---|---|
| entities | List <?> | Optional | List of entities. The format of the entities differs per listing and each entity in the list is always identical to the response of a GET request on the entity. Field will only be absent when a count only is requested with limit=0. | |
| pagination | pagination | Required | Pagination metadata |