Search for issues using JQL.

Note: Recent updates might not be immediately visible in the returned search results, if you need to read immediately after write, you can use the Reconcile Issues parameter to ensure stronger consistency assurances.

Permissions required:

  • Browse projects (for the project containing the issue).
  • If issue-level security is configured, the user needs permissions to view the issue.

External Documentation

To learn more, visit the Jira documentation.

​
Basic Parameters

ParameterDescription
FieldsA comma-separated list of fields to return for each issue.Options: (Defaults to id)* *all - Returns all fields.* *navigable - Returns navigable fields.* id - Returns only issue IDs.* Any issue field, prefixed with a minus to exclude.Examples:* summary,comment Returns only the summary and comments fields only.* -description Returns all navigable (default) fields except description.* *all,-comment Returns all fields except comments.
LimitThe maximum number of items to return per page.
Next Page TokenThe token for a page to fetch (that is not the first page).Note: The token is not included in the response for the last page (indicating that there is no next page).
QueryA JQL expression.Note: This parameter requires a bounded query (with a search restriction). An unbounded expression can be added to the JQL query.Example of a valid bounded query:* project = ‘example’Example of a mixed query that incorporates both bounded and unbounded expressions:* project = ‘example’ ORDER BY key DESCNote: ORDER BY clause can contain a maximum of 7 fields.
Use Instance TimezoneWhen checked, your Jira instance timezone will be used when writing JQL date filters.

​
Advanced Parameters

ParameterDescription
ExpandSelect options of additional information to include in the response.Options:* renderedFields - Returns field values rendered in HTML format.* names - Returns the display name of each field.* schema - Returns the schema describing a field type.* transitions - Returns all possible transitions for the issue.* operations - Returns all possible operations for the issue.* editmeta - Returns information about how each field can be edited.* changelog - Returns a list of recent updates to an issue, sorted by date, starting from the most recent.* versionedRepresentations - Returns a JSON array containing each version of a field’s value, with the highest numbered item representing the most recent version.
Fail FastSelect to stop the request early if Jira can’t retrieve all the fields.
Fields By KeysSelect to reference the fields by their key (rather than ID).
PropertiesA comma-separated list of up to 5 issue properties to include in the results.
Reconcile IssuesA comma-separated list of IDs, representing issues that require strong consistency reconciliation with search results.(Maximum 50 IDs).

​
Example Output

{
	"issues": [
		{
			"expand": "",
			"fields": {
				"watcher": {
					"isWatching": false,
					"self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
					"watchCount": 1
				},
				"attachment": [
					{
						"author": {
							"accountId": "5b10a2844c20165700ede21g",
							"accountType": "atlassian",
							"active": false,
							"avatarUrls": {
								"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
								"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
								"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
								"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
							},
							"displayName": "Mia Krystof",
							"key": "",
							"name": "",
							"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
						},
						"content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001",
						"created": "2023-06-24T19:24:50.000+0000",
						"filename": "debuglog.txt",
						"id": 10001,
						"mimeType": "text/plain",
						"self": "https://your-domain.atlassian.net/rest/api/2/attachments/10001",
						"size": 2460
					}
				],
				"sub-tasks": [
					{
						"id": "10000",
						"outwardIssue": {
							"fields": {
								"status": {
									"iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
									"name": "Open"
								}
							},
							"id": "10003",
							"key": "ED-2",
							"self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
						},
						"type": {
							"id": "10000",
							"inward": "Parent",
							"name": "",
							"outward": "Sub-task"
						}
					}
				],
				"description": "Main order flow broken",
				"project": {
					"avatarUrls": {
						"16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
						"24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
						"32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
						"48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
					},
					"id": "10000",
					"insight": {
						"lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
						"totalIssueCount": 100
					},
					"key": "EX",
					"name": "Example",
					"projectCategory": {
						"description": "First Project Category",
						"id": "10000",
						"name": "FIRST",
						"self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
					},
					"self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
					"simplified": false,
					"style": "classic"
				},
				"comment": [
					{
						"author": {
							"accountId": "5b10a2844c20165700ede21g",
							"active": false,
							"displayName": "Mia Krystof",
							"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
						},
						"body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
						"created": "2021-01-17T12:34:00.000+0000",
						"id": "10000",
						"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
						"updateAuthor": {
							"accountId": "5b10a2844c20165700ede21g",
							"active": false,
							"displayName": "Mia Krystof",
							"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
						},
						"updated": "2021-01-18T23:45:00.000+0000",
						"visibility": {
							"identifier": "Administrators",
							"type": "role",
							"value": "Administrators"
						}
					}
				],
				"issuelinks": [
					{
						"id": "10001",
						"outwardIssue": {
							"fields": {
								"status": {
									"iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
									"name": "Open"
								}
							},
							"id": "10004L",
							"key": "PR-2",
							"self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
						},
						"type": {
							"id": "10000",
							"inward": "depends on",
							"name": "Dependent",
							"outward": "is depended by"
						}
					},
					{
						"id": "10002",
						"inwardIssue": {
							"fields": {
								"status": {
									"iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
									"name": "Open"
								}
							},
							"id": "10004",
							"key": "PR-3",
							"self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
						},
						"type": {
							"id": "10000",
							"inward": "depends on",
							"name": "Dependent",
							"outward": "is depended by"
						}
					}
				],
				"worklog": [
					{
						"author": {
							"accountId": "5b10a2844c20165700ede21g",
							"active": false,
							"displayName": "Mia Krystof",
							"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
						},
						"comment": "I did some work here.",
						"id": "100028",
						"issueId": "10002",
						"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
						"started": "2021-01-17T12:34:00.000+0000",
						"timeSpent": "3h 20m",
						"timeSpentSeconds": 12000,
						"updateAuthor": {
							"accountId": "5b10a2844c20165700ede21g",
							"active": false,
							"displayName": "Mia Krystof",
							"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
						},
						"updated": "2021-01-18T23:45:00.000+0000",
						"visibility": {
							"identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
							"type": "group",
							"value": "jira-developers"
						}
					}
				],
				"updated": 1,
				"timetracking": {
					"originalEstimate": "10m",
					"originalEstimateSeconds": 600,
					"remainingEstimate": "3m",
					"remainingEstimateSeconds": 200,
					"timeSpent": "6m",
					"timeSpentSeconds": 400
				}
			},
			"id": "10002",
			"key": "ED-1",
			"self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
		}
	]
}

​
Workflow Library Example

List Issues with Jira and Send Results Via Email

Workflow Library

Preview this Workflow on desktop