List entities
ListEntities
Returns list of entities based on specified parameters.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Maximum number of records to return
Filter the result-set by properties using a subset of the Kibana Query Language. Only AND statements are supported.
E.g. disabled:false and type_id:competition
For filtering on entities without a type_id, use type_id:default.
Specifies the result ordering for List requests. Supported values are:
- "name asc|desc"
This order is not applied when combined with
searchorpinnedparameters.
The pagination token in the List request.
Any user-provided search query (as a plain string). This works in tandem with the filter parameter.
Using search will automatically order all results by relevance instead of the supplied order_by value.
One or more entity IDs that you want to receive at the top of the results (if it is available).
Pinned items will not be included in the results if it does not match the filter. It will, however, ignore the
search parameter.
Using pinned will automatically order all results by relevance instead of the supplied order_by value.