Filters reference
This reference provides detailed information about the filters that you can use in your filtering rules.
Supported filters
The supported filters for any given field are dependent on the field's type. The table below lists the filters that are available for each field type.
Text filters
Text filters are generally supported for fields with a type of Short text, Paragraph or URL.
| Filter name | Required parameters | Optional parameters | Description |
|---|---|---|---|
| Equal to | Value: string | Case sensitive: boolean | Matches field values that exactly match the specified string, with or without case sensitivity. |
| Not equal to | Value: string | Case sensitive: boolean | Matches field values that do not exactly match the specified string, with or without case sensitivity. |
| Contains | Value: string | Case sensitive: boolean | Matches field values that contain the specified string, with or without case sensitivity. |
| Does not contain | Value: string | Case sensitive: boolean | Matches field values that do not contain the specified string, with or without case sensitivity. |
| Starts with | Value: string | Case sensitive: boolean | Matches field values that start with the specified string, with or without case sensitivity. |
| Ends with | Value: string | Case sensitive: boolean | Matches field values that end with the specified string, with or without case sensitivity. |
| Does not end with | Value: string | Case sensitive: boolean | Matches field values that do not end with the specified string, with or without case sensitivity. |
| Is empty | None | None | Matches field values that are empty. |
| Is not empty | None | None | Matches field values that are not empty. |
Number filters
Number filters are generally supported for fields with a type of Number, Duration, Percentage or Formula.
| Filter name | Required parameters | Optional parameters | Description |
|---|---|---|---|
| Equal to | Value: number | None | Matches field values that exactly match the specified number. |
| Not equal to | Value: number | None | Matches field values that do not match the specified number. |
| Greater than | Value: number | None | Matches field values that are greater than the specified number. |
| Greater than or equal to | Value: number | None | Matches field values that are greater than or equal to the number. |
| Less than | Value: number | None | Matches field values that are less than the specified number. |
| Less than or equal to | Value: number | None | Matches field values that are less than or equal to the number. |
| Is empty | None | None | Matches field values that are empty. |
| Is not empty | None | None | Matches field values that are not empty. |
Date filters
Date filters are generally supported for fields with a type of Date or Date/Time.
| Filter name | Required parameters | Optional parameters | Description |
|---|---|---|---|
| On | Value: date | Precision: Precision | Matches field values that match the specified date. |
| Not on | Value: date | Precision: Precision | Matches field values that do not match the specified date. |
| After | Value: date | Precision: Precision | Matches field values that are after the specified date. |
| On or after | Value: date | Precision: Precision | Matches field values that are on or after the specified date. |
| Before | Value: date | Precision: Precision | Matches field values that are before the specified date. |
| On or before | Value: date | Precision: Precision | Matches field values that are on or before the specified date. |
| Is empty | None | None | Matches field values that are empty. |
| Is not empty | None | None | Matches field values that are not empty. |
The Precision parameter can be one of the following:
- Within the same day (default)
- Within the same week
- Within the same month
- Within the same quarter
- Within the same year
User filters
User filters are generally available for fields with a type of User (Single).
| Filter name | Required parameters | Optional parameters | Description |
|---|---|---|---|
| Equal to | Value: User | None | Matches field values that match the specified user. |
| Not equal to | Value: User | None | Matches field values that do not match the specified user. |
| Is empty | None | None | Matches field values that are empty. |
| Is not empty | None | None | Matches field values that are not empty. |
Issue Key filters
Issue Key filters are generally available for fields with a type of Issue Key.
| Filter name | Required parameters | Optional parameters | Description |
|---|---|---|---|
| Equal to | Value: IssueKey | None | Matches field values that match the specified issue key. |
| Not equal to | Value: IssueKey | None | Matches field values that do not match the specified issue key. |
| Is empty | None | None | Matches field values that are empty. |
| Is not empty | None | None | Matches field values that are not empty. |
The IssueKey value must follow the format "PROJECT-123", where "PROJECT" is the project key and "123" is the issue number.
Project Type filters
Project Type filters are generally available for fields with a type of Project Type.
| Filter name | Required parameters | Optional parameters | Description |
|---|---|---|---|
| Equal to | Value: ProjectType | None | Matches field values that match the specified project type. |
| Not equal to | Value: ProjectType | None | Matches field values that do not match the specified project type. |
The ProjectType value can be one of the following:
- Business
- Product Discovery
- Service Management
- Software