---
title: "getFilter"
canonical: "https://support.appfire.com/space/JCLI/70783239/getFilter"
format: markdown
---
> Macro (aura-html)

See also: [Actions](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70787366)

> Macro (details)
> 
> | **Description** | Get information about a filter by id or filter name (if it is a favorite filter). |
> | --- | --- |
> | **Required Parameters** | [id](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70784857) or [filter](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70784279) |
> | **Optional Parameters** | [outputType](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70784259), [file](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70784297), [append](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70790085), [encoding](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70785169) |
> | **Type** | [Get](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70780909/Action+Types#ActionTypes-Get) |
> | **Category** | [Filters](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70780591/Action+Categories#ActionCategories-Filters) |
> | **Output Formats** |  |
> | **Replacement Variables** | filter, filterId |
> | **Hosting** | cloud,server,datacenter |
> | **Since Version** |  |
> | **Examples** | [getFilter](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70782732/Examples#Examples-getFilter) |

## Related How To's

> Macro (cql-query)