Set up Jira Cloud
Learn how to set up Jira Cloud and integrate it with other products and applications.
JQL lets you search for a value in a specific field. Each field in Jira has a corresponding JQL name. If you’ve made a custom field, you’ll be asked to name the field.
In a clause, a field is followed by an operator, which in turn is followed by one or more values (or functions). The operator compares the value of the field with one or more values or functions on the right, such that only true results are retrieved by the clause. It's not possible to compare two fields in JQL.
Search for issues that are assigned to a particular affects version(s). You can search by version name or version ID (i.e. the number that Jira automatically allocates to a version). Note, it is better to search by version ID than by version name. Different projects may have versions with the same name. It is also possible for your Jira administrator to change the name of a version, which could break any saved filters that rely on that name. Version IDs, however, are unique and cannot be changed.
Syntax | 1
affectedVersion |
---|---|
Field Type | VERSION |
Auto-complete | Yes |
Supported operators | = , != , > , >= , < , <= |
Unsupported operators | ~ , !~ |
Supported functions | When used with the = and != operators, this field supports:
When used with the IN and NOT IN operators, this field supports:
|
Examples |
|
Used in business projectsJira Service Management only.
Search for requests that have been approved or require approval. This can be further refined by user.
Syntax | 1
approvals |
---|---|
Field Type | USER |
Auto-complete | No |
Supported operators | = |
Unsupported operators | ~ , != , !~ , > , >= , < , <= |
Supported functions |
|
Examples |
|
Search for issues that are assigned to a particular user. You can search by the user's full name, ID, or email address.
Syntax | 1
assignee |
---|---|
Field Type | USER |
Auto-complete | Yes |
Supported operators | = , != Note that the comparison operators (e.g. ">") use the version order that has been set up by your project administrator, not a numeric or alphabetic order. |
Unsupported operators | ~ , !~ , > , >= , < , <= |
Supported functions | When used with the IN and NOT IN operators, this field supports:
When used with the EQUALS and NOT EQUALS operators, this field supports:
|
Examples |
|
Search for issues that have or do not have attachments.
Syntax | 1
attachments |
---|---|
Field Type | ATTACHMENT |
Auto-complete | Yes |
Supported operators | IS, IS NOT |
Unsupported operators | =, != , ~ , !~ , > , >= , < , <= IN, NOT IN, WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported functions | None |
Examples |
|
Search for issues that belong to projects in a particular category.
Syntax | 1
category |
---|---|
Field Type | CATEGORY |
Auto-complete | Yes |
Supported operators | =, != |
Unsupported operators | ~ , !~ , > , >= , < , <= WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported functions | None |
Examples |
|
Used in business projects only.
Search for types of change gating that are used in change requests. "Tracked-only" requests are produced by integrations that stand separately from a change management process. These tools don't respect approval or change gating strategies. Change requests that are "tracked-only" are just for record-keeping purposes.
Syntax | 1
change-gating-type |
---|---|
Field Type | TEXT |
Auto-complete | Yes |
Supported operators | = , != IS, IS NOT, IN, NOT IN |
Unsupported operators | ~ , !~ , > , >= , < , <= WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported functions | None |
Examples |
|
Search for issues that have a comment that contains particular text using Jira text-search syntax. More about searching syntax for text fields.
Syntax | 1
comment |
---|---|
Field Type | TEXT |
Auto-complete | No |
Supported operators | ~ , !~ |
Unsupported operators | = , != , > , >= , < , <= |
Supported functions | None |
Examples |
|
Search for issues that belong to a particular component(s) of a project. You can search by component name or component ID (i.e. the number that Jira automatically allocates to a component).
Note, it is safer to search by component ID than by component name. Different projects may have components with the same name, so searching by component name may return issues from multiple projects. It is also possible for your Jira administrator to change the name of a component, which could break any saved filters that rely on that name. Component IDs, however, are unique and cannot be changed.
Syntax | 1
component |
---|---|
Field Type | COMPONENT |
Auto-complete | Yes |
Supported operators | = , != |
Unsupported operators | ~ , !~ , > , >= , < , <= WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported functions | When used with the IN and NOT IN operators, component supports:
|
Examples |
|
Search for issues that were created on, before, or after a particular date (or date range). Note that if a time-component is not specified, midnight will be assumed. Please note that the search results will be relative to your configured time zone (which is by default the Jira server's time zone).
Use one of the following formats:
"yyyy/MM/dd HH:mm"
"yyyy-MM-dd HH:mm"
"yyyy/MM/dd"
"yyyy-MM-dd"
Or use "w" (weeks), "d" (days), "h" (hours) or "m" (minutes) to specify a date relative to the current time. The default is "m" (minutes). Be sure to use quote-marks ("); if you omit the quote-marks, the number you supply will be interpreted as milliseconds after epoch (1970-1-1).
Syntax | 1
created |
---|---|
Alias | 1
createdDate |
Field Type | DATE |
Auto-complete | No |
Supported operators | = , != , > , >= , < , <= IS , IS NOT , IN , NOT IN |
Unsupported operators | ~ , !~ WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported functions | When used with the EQUALS, NOT EQUALS, GREATER THAN, GREATER THAN EQUALS, LESS THAN or LESS THAN EQUALS operators, this field supports:
|
Examples |
|
Search for issues that were created by a particular user. You can search by the user's full name, ID, or email address. Note that an issue's creator does not change, so you cannot search for past creators (e.g. WAS). See Reporter for more options.
Syntax | 1
creator |
---|---|
Field Type | USER |
Auto-complete | Yes |
Supported operators | = , != |
Unsupported operators | ~ , !~ , > , >= , < , <= CHANGED, WAS, WAS IN, WAS NOT, WAS NOT IN |
Supported functions | When used with the IN and NOT IN operators, this field supports:
When used with the EQUALS and NOT EQUALS operators, this field supports:
|
Examples |
|
Only applicable if your Jira administrator has created one or more custom fields.
Search for issues where a particular custom field has a particular value. You can search by custom field name or custom field ID (i.e. the number that Jira automatically allocates to a custom field).
Note, it is safer to search by custom field ID than by custom field name. It is possible for a custom field to have the same name as a built-in Jira system field; in which case, Jira will search for the system field (not your custom field). It is also possible for your Jira administrator to change the name of a custom field, which could break any saved filters that rely on that name. Custom field IDs, however, are unique and cannot be changed.
For multiple choice and dropdown custom fields, you can search by both option value and option ID. However, for performance reasons, when using closedSprints(), futureSprints(), and openSprints(), you can only search by option value. For example, if closedSprints() were to return 16, the following query:
1
"customField1[Dropdown]" in (12, closedSprints())
would search for option values 12 and 16 and ID 12.
Syntax | 1
CustomFieldName |
---|---|
Alias | 1
cf[CustomFieldID] |
Field Type | Depends on the custom field's configuration Jira text-search syntax can be used with custom fields of type 'Text'. |
Auto-complete | Yes, for custom fields of type picker, group picker, select, checkbox and radio button fields |
Supported operators | Different types of custom field support different operators. |
Supported operators: | = , != , > , >= , < , <= |
Unsupported operators: | ~ , !~ WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported operators: | = , != |
Unsupported operators: | ~ , !~ , > , >= , < , <= WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported operators: | ~ , !~ |
Unsupported operators: | = , != , > , >= , < , <= IN , NOT IN , WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported operators: | = , != |
Unsupported operators: | ~ , !~ , > , >= , < , <= WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported functions | Different types of custom fields support different functions. |
Supported functions: | When used with the EQUALS, NOT EQUALS, GREATER THAN, GREATER THAN EQUALS,
|
Supported functions: | Version picker fields: When used with the IN and NOT IN operators, this field supports:
|
Examples |
|
Search for issues where the description contains particular text using Jira text-search syntax. More about searching syntax for text fields.
Syntax | 1
description |
---|---|
Field Type | TEXT |
Auto-complete | No |
Supported operators | ~ , !~ |
Unsupported operators | = , != , > , >= , < , <= IN , NOT IN, WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED |
Supported functions | None |
Examples |
|
Search for issues that were due on, before, or after a particular date (or date range). Note that the due date relates to the date only (not to the time).
Use one of the following formats:
"yyyy/MM/dd"
"yyyy-MM-dd"
Or use "w" (weeks) or "d" (days) to specify a date relative to the current date. Be sure to use quote-marks (").
Syntax | 1
due |
---|---|
Alias | 1
dueDate |
Field Type | DATE |
Auto-complete | No |
Supported operators | = , != , > , >= , < , <= |
Unsupported operators | ~ , !~ WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED |
Supported functions | When used with the EQUALS, NOT EQUALS, GREATER THAN, GREATER THAN EQUALS,
|
Examples |
|
Search for issues where the environment contains particular text using Jira text-search syntax. More about searching syntax for text fields.
Syntax | 1
environment |
---|---|
Field Type | TEXT |
Auto-complete | No |
Supported operators | ~ , !~ |
Unsupported ope |