get /filters
Gets the list of filters.
Returns the list of filters that are visible to the user.
The response includes the title and other details about each filter. The list can be filtered by a particular app, and is sorted in the order specified by the sort parameter.
Query parameters
- offset (optional)
- The number of entries to skip. Default is 0.
- limit (optional)
- The maximum number of entries to return. Default is 50.
- sort (optional)
A comma separated list of fields used for sorting the filters. Allowed field values are "name" and "created". Fields can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order. Default is -created.
Usage example: /filters?sort=+name,-created
- appId (optional)
- The ID of the app to filter on.
- enabled (optional)
- Indicates whether to retrieve the active filters (true) or inactive filters (false).
Return type
Example data
Content-Type: application/json
{
"data" : {
"totalItems" : 0,
"offset" : 6,
"limit" : 1,
"items" : [ {
"variables" : [ {
"name" : "name",
"connectionId" : "00000000-0000-0000-0000-000000000000",
"value" : "value",
"evaluate" : true
}, {
"name" : "name",
"connectionId" : "00000000-0000-0000-0000-000000000000",
"value" : "value",
"evaluate" : true
} ],
"created" : "2000-01-23T04:56:07.000+00:00",
"appId" : "00000000-0000-0000-0000-000000000000",
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"description" : "description",
"id" : "00000000-0000-0000-0000-000000000000",
"fields" : [ {
"overrideValues" : false,
"values" : [ {
"type" : "text",
"value" : "value"
}, {
"type" : "text",
"value" : "value"
} ],
"name" : "name",
"connectionId" : "00000000-0000-0000-0000-000000000000",
"selectExcluded" : false
}, {
"overrideValues" : false,
"values" : [ {
"type" : "text",
"value" : "value"
}, {
"type" : "text",
"value" : "value"
} ],
"name" : "name",
"connectionId" : "00000000-0000-0000-0000-000000000000",
"selectExcluded" : false
} ],
"enabled" : true
}, {
"variables" : [ {
"name" : "name",
"connectionId" : "00000000-0000-0000-0000-000000000000",
"value" : "value",
"evaluate" : true
}, {
"name" : "name",
"connectionId" : "00000000-0000-0000-0000-000000000000",
"value" : "value",
"evaluate" : true
} ],
"created" : "2000-01-23T04:56:07.000+00:00",
"appId" : "00000000-0000-0000-0000-000000000000",
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"description" : "description",
"id" : "00000000-0000-0000-0000-000000000000",
"fields" : [ {
"overrideValues" : false,
"values" : [ {
"type" : "text",
"value" : "value"
}, {
"type" : "text",
"value" : "value"
} ],
"name" : "name",
"connectionId" : "00000000-0000-0000-0000-000000000000",
"selectExcluded" : false
}, {
"overrideValues" : false,
"values" : [ {
"type" : "text",
"value" : "value"
}, {
"type" : "text",
"value" : "value"
} ],
"name" : "name",
"connectionId" : "00000000-0000-0000-0000-000000000000",
"selectExcluded" : false
} ],
"enabled" : true
} ]
}
}
Responses
- 200
- Success. A paginated list of filters is returned.
- 400
- Parameters of the query string are malformed.