Get started with Jira Service Management for admins
Your first stop for learning how to get started with Jira Service Management.
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 Jira 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 Jira Service Management 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.
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.
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 |
|
Used in Jira Service Management only.
Search for requests of a certain request type. You can search by request type name or request type description as configured in the Request Type configuration screen.
Syntax | 1
"Customer Request Type" |
---|---|
Field Type | Custom field |
Auto-complete | Yes |
Supported operators | 1
= , != IN , NOT IN |
Unsupported operators | ~ , !~ , > , >= , < , <= IS , IS NOT, WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED Note that the Lucene value for Customer Request Type, is portal-key/request-type-key. While the portal key cannot be changed after a service project portal is created, the project key can be changed. The Request Type key cannot be changed once the Request Type is created. |
Supported functions | None |
Examples |
|
Search for issues where the description contains particular text using Jira text-search syntax.
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.
Syntax | 1
environment |
---|---|
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 belong to a particular epic in company-managed projects. The search is based on either the epic's name, issue key, or issue ID (i.e. the number that Jira automatically allocates to an issue).
To search for issues that belong to a particular epic in team-managed projects, use parent.
Syntax | 1
"epic link" |
---|---|
Field Type | Epic Link Relationship |
Auto-complete | No |
Supported operators | = , != |
Unsupported operators | ~ , !~ , > , >= , < , <= WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED |
Supported functions | When used with the IN or NOT IN operators, epic link supports:
|
Examples |
|
You can use a saved filter to narrow your search. You can search by filter name or filter ID (i.e. the number that Jira automatically allocates to a saved filter).
Note:
It is safer to search by filter ID than by filter name. It is possible for a filter name to be changed, which could break a saved filter that invokes another filter by name. Filter IDs, however, are unique and cannot be changed.
An unnamed link statement in your typed query will override an ORDER BY statement in the saved filter.
You cannot run or save a filter that would cause an infinite loop (i.e. you cannot reference a saved filter if it eventually references your current filter).
Syntax | 1
filter |
---|---|
Aliases | 1
request , savedFilter , searchRequest |
Field Type | Filter |
Auto-complete | Yes |
Supported operators | = , != |
Unsupported operators | ~ , !~ , > , >= , < , <= IS , IS NOT, WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED |
Supported functions | None |
Examples |
|
Search for issues that are assigned to a particular fix version. You can search by version name or version ID (i.e. the number that Jira automatically allocates to a version).
It’s safer to search by version ID than by version name. Different projects may have versions with the same name, so searching by version name may return issues from multiple projects. 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
fixVersion |
---|---|
Field Type | VERSION |
Auto-complete | Yes |
Supported operators | = , != , > , >= , < , <= Note that the comparison operators (e.g. ">") use the version order that has |
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 |
|
Filter issues according to their hierarchy level using a JQL filter. This field uses numbers that correlate to hierarchy levels. Use:
1 to filter by parent level task, such as epics. This level is defined by your Jira administrator.
0 to filter by standard level issues, such as stories or tasks
-1 to filter by subtasks
Currently, this field doesn’t support custom hierarchy levels made in Advanced Roadmaps.
Syntax | 1
hierarchyLevel |
---|---|
Field Type | Number |
Auto-complete | Yes |
Supported operators | 1
= , != , > , >= , < , <= , IN , NOT IN |
Unsupported operators | ~ , !~ , IS, IS NOT, WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED |
Supported functions |
|
Examples |
|
Search for issues with a particular issue key or issue ID (i.e. the number that Jira automatically allocates to an issue).
Syntax | 1
issueKey |
---|---|
Aliases | 1
id , issue , key |
Field Type | ISSUE |
Auto-complete | No |
Supported operators | = , != , > , >= , < , <= |
Unsupported operators | ~ , !~ |
Supported functions | When used with the IN or NOT IN operators, issueKey supports:
|
Examples |
|
Searches for issues linked or not linked to an issue. You can restrict the search to links of a particular type.
Syntax | issueLink, issueLink["link type"], or issueLinkType, where link type or LinkType is a variable you replace with the issue link type (blocks, duplicates, or is blocked by, for example). |
---|---|
Auto-complete | Yes |
Supported operators | = , != IN , NOT IN |
Unsupported operators | ~ , !~ , > , >= , < , <= WAS , WAS IN , WAS NOT , WAS NOT IN , CHANGED , IS , IS NOT |
Supported functions | None |
Examples | Find issues:
|
Search for issues that have a particular link type, like blocks or is duplicated by. You can only find issues from the Jira instance you're searching on; remote links to issues on other Jira instances won’t be included.
Use this JQL query to add colors to your issue cards! For example, add a red stripe to issues that have some blockers, and keep all other issues green. This will help you bring the right information to your team’s attention, at a glance. For more info, see Customizing cards.
Syntax | 1
issueLinkType |
---|---|
Auto-complete | Yes |
Supported operators | = , != |
Unsupported operators | ~ , !~ , > , >= , < , <= WAS , WAS IN , WAS NOT , WAS NOT IN , CHANGED , IS , IS NOT |
Supported functions | None |
Examples | Find issues:
|
Jira issue link types have the following properties:
Name: The title for the link type
Outward description: The description of how an issue affects other issues
Inward description: The description of how an issue is affected by other issues
For example, a link type could have the following properties:
Name: Problem/Incident
Outward description: causes
Inward description: is caused by
When searching issueLinkType, Jira searches all three properties. This can mean you're unable to isolate issues with a specific inward or outward description if the link type's name and either of the descriptions are the same. This is the case for the default "Blocks" link type, where the name and outward description are "blocks".
If you need to be able to search specifically for issues with an outward description of "blocks", for example, a Jira administrator must change the name of the link type to something else. If you're a Jira admin, take a look at Configuring issue linking for more info.
Search for issues tagged with a label or list of labels. You can also search for issues without any labels to easily identify which issues need to be tagged so they show up in the relevant sprints, queues or reports.
Syntax | 1
labels |
---|---|
Field Type | LABEL |
Auto-complete | Yes |
Supported operators | = , !=, IS, IS NOT, IN, NOT IN |
Unsupported operators | ~ , !~ , , > , >= , < , <= |
Supported functions | None |
Examples |
|
Search for issues that were last viewed 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
lastViewed |
---|---|
Field Type | DATE |
Auto-complete | No |
Supported operators | = , != , > , >= , < , <= |
Unsupported operators | ~ , !~ |
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 |
|
Only available if issue level security has been enabled by your Jira administrator.
Search for issues with a particular security level. You can search by issue level security name or issue level security ID (i.e. the number that Jira automatically allocates to an issue level security).
Note, it is safer to search by security level ID than by security level name. It is possible for your Jira administrator to change the name of a security level, which could break any saved filter that rely on that name. Security level IDs, however, are unique and cannot be changed.
Syntax | 1
level |
---|---|
Field Type | SECURITY LEVEL |
Auto-complete | Yes |
Supported operators | = , != |
Unsupported operators | > , >= , < , <= , ~ , !~ |
Supported functions | None |
Examples |
|
Used in Jira Service Management only.
Search for all requests shared with an organization. Requests that were kept private won't be returned.
Syntax | 1
organizations |
---|---|
Field Type | USER |
Auto-complete | Yes |
Supported operators | = , != |
Examples | Search for all requests shared with the organization Atlassian: 1
organizations = "Atlassian" |
Only available if time-tracking has been enabled by your Jira administrator.
Search for issues where the original estimate is set to a particular value (i.e. a number, not a date or date range). Use "w", "d", "h" and "m" to specify weeks, days, hours, or minutes.
Syntax | 1
originalEstimate |
---|---|
Alias | 1
timeOriginalEstimate |
Field Type | DURATION |
Auto-complete | No |
Supported operators | = , != , > , >= , < , <= |
Unsupported operators | ~ , !~ |
Supported functions | None |
Examples |
|
Search for all subtasks of a particular issue in company-managed projects or subtasks of a particular epic in team-managed projects. You can search by issue key or by issue ID (i.e. the number that Jira automatically allocates to an Issue).
Syntax | 1
parent |
---|---|
Field Type | ISSUE |
Auto-complete | No |
Supported operators | = , != |
Unsupported operators | > , >= , < , <= , ~ , !~ |
Supported functions | None |
Examples |
|
Search for issues with a particular priority. You can search by priority name or priority ID (i.e. the number that Jira automatically allocates to a priority).
Note, it is safer to search by priority ID than by priority name. It is possible for your Jira administrator to change the name of a priority, which could break any saved filter that rely on that name. Priority IDs, however, are unique and cannot be changed.
Syntax | 1
priority |
---|---|
Field Type | PRIORITY |
Auto-complete | Yes |
Supported operators | = , != , > , >= , < , <= IS , IS NOT, IN , NOT IN , WAS, WAS IN, WAS NOT, WAS NOT IN , CHANGED |
Unsupported operators | ~ , !~ |
Supported functions | None |
Examples |
|
Search for issues that belong to a particular project. You can search by project name, by project key or by project ID (i.e. the number that Jira automatically allocates to a project). In the rare case where there is a project whose project key is the same as another project's name, then the project key takes preference and hides results from the second project.
Syntax | 1
project |
---|---|
Field Type | PROJECT |
Auto-complete | Yes |
Supported operators | = , != |
Unsupported operators | > , >= , < , <= , ~ , !~ |
Supported functions | When used with the IN and NOT IN operators, project supports:
|
Examples |
|
Search for issues that belong to a particular type of project, either:
“business” which finds issues created in Jira Work Management projects
“software” which finds issues created in Jira Software projects
“service_desk” which finds issues created in Jira Service Management projects
Results depend on your permission level. You will only see results for products you have access to. Learn more about product access.
Syntax | projectType |
---|---|
Auto-complete | Yes |
Supported operators | =, != IN, NOT IN |
Unsupported operators | >, >=, <, <=, ~, !~ IS, IS NOT, WAS, WAS NOT, WAS NOT IN, CHANGED |
Supported functions | None |
Examples | Find all issues in a software project: projectType = ”software” Find all issues in either a software project or a service project: projectType = ”software” OR projectType = ”service_desk” Find all issues that aren’t in a software project: projectType != ”software” |
Only available if time-tracking has been enabled by your Jira administrator.
Search for issues where the remaining estimate is set to a particular value (i.e. a number, not a date or date range). Use "w", "d", "h" and "m" to specify weeks, days, hours, or minutes.
Syntax | 1
remainingEstimate |
---|---|
Alias | 1
timeEstimate |
Field Type | DURATION |
Auto-complete | No |
Supported operators | = , != , > , >= , < , <= |
Unsupported operators | ~ , !~ |
Supported functions | None |
Examples |
|
Search for issues that were reported by a particular user. This may be the same as the creator, but can be distinct. You can search by the user's full name, ID, or email address.
Syntax | 1
reporter |
---|---|
Field Type | USER |
Auto-complete | Yes |
Supported operators | = , != |
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 |
|
Used in Jira Service Management only.
Search for requests by the channel that they were created by. For example, you could search for all requests that were emailed to the service project, or all requests that were sent from a customer portal.
Syntax | 1
request-channel-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 | When used with the IN and NOT IN operators, this field supports:
|
Examples |
|
Used in Jira Service Management only.
Search for requests 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. Search results are 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
request-last-activity-time |
---|---|
Field Type | DATE |
Auto-complete | Yes |
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,
|
Examples |
|