Get All Filters

Returns Civic Platform search filters (previously known as "quick queries" in the Civic Platform application). Include the {type} URI parameter to get either a record, inspection, or workflow task filters.

Resource Information

Scope filters
App Type Agency
Authorization Type Access token
URI /v4/filters?type={type}&lang={lang}
Automation Version(s) 9.0.0

Request Information

Field or Parameter Type Required Values Description Automation Version
lang String No   Indicates the language applied. 9.0.0
type string No record | inspection | workflowtask The type of Civic Platform search filter. 9.0.0

Response Information

Field Type Description Automation Version
result[] result{} Contains search filter information. 9.0.0
result.datafilterType string Indicates whether a search filter is pre-defined ("QuickQuery") or user-defined ("UserQuickQuery"). 9.0.0
result.description string Describes the search filter. 9.0.0 long The unique identifier of the search filter. 9.0.0 string The display name of the search filter. 9.0.0
result.primary string Indicates whether or not the search filter is the primary search filter. 9.0.0
result.type string The type of search filter. 9.0.0
status integer The record status. 9.0.0