Filter
This API documentation page is created to help you understand how to filter results with our platform's API. Filters can narrow your search results and retrieve only the data that meets your specific criteria. At the moment, the only supported filter type is labels.
The filter object
- Name
type
- Type
- string
- Description
Determines the type of filter to apply. Currently only
labels
is supported.
- Name
operator
- Type
- string
- Description
Determines the operator to use when applying the filter. This can be either
AND
orOR
.
- Name
values
- Type
- string[]
- Description
An array of values to use when applying the filter. The values in this array are used to match against the values of the labels that are attached to the items being filtered.