Searches for issues using JQL.

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

This operation can be accessed anonymously.

Permissions required: Issues are included in the response where the user has:

​
Parameters

ParameterDescription
LimitThe maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting id or key only.
OffsetThe index of the first item to return in a page of results (page offset).
QueryThe JQL that defines the search. Note: * If no JQL expression is provided, all issues are returned. * username and userkey cannot be used as search terms due to privacy reasons. Use accountId instead. * If a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.
Use Instance TimezoneWhen checked, your Jira instance timezone will be used when writing JQL date filters.

​
Example Output

{
	"expand": "names,schema",
	"issues": [
		{
			"expand": "",
			"fields": {
				"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\u0026s=16",
								"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24\u0026s=24",
								"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32\u0026s=32",
								"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48\u0026s=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/secure/attachments/10000/picture.jpg",
						"created": "2021-08-19T05:11:52.810+0000",
						"filename": "picture.jpg",
						"id": 10000,
						"mimeType": "image/jpeg",
						"self": "https://your-domain.atlassian.net/rest/api/3/attachments/10000",
						"size": 23123,
						"thumbnail": "https://your-domain.atlassian.net/jira/secure/thumbnail/10000/picture.jpg"
					}
				],
				"comment": [
					{
						"author": {
							"accountId": "5b10a2844c20165700ede21g",
							"active": false,
							"displayName": "Mia Krystof",
							"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
						},
						"body": {
							"content": [
								{
									"content": [
										{
											"text": "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.",
											"type": "text"
										}
									],
									"type": "paragraph"
								}
							],
							"type": "doc",
							"version": 1
						},
						"created": "2021-08-19T05:11:52.828+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-08-19T05:11:52.828+0000",
						"visibility": {
							"type": "role",
							"value": "Administrators"
						}
					}
				],
				"description": {
					"content": [
						{
							"content": [
								{
									"text": "Main order flow broken",
									"type": "text"
								}
							],
							"type": "paragraph"
						}
					],
					"type": "doc",
					"version": 1
				},
				"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"
						}
					}
				],
				"project": {
					"avatarUrls": {
						"16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall\u0026pid=10000",
						"24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small\u0026pid=10000",
						"32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium\u0026pid=10000",
						"48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large\u0026pid=10000"
					},
					"id": "10000",
					"insight": {
						"lastIssueUpdateTime": "2021-08-19T05:11:51.747+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"
				},
				"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"
						}
					}
				],
				"timetracking": {
					"originalEstimate": "10m",
					"originalEstimateSeconds": 600,
					"remainingEstimate": "3m",
					"remainingEstimateSeconds": 200,
					"timeSpent": "6m",
					"timeSpentSeconds": 400
				},
				"updated": 1,
				"watcher": {
					"isWatching": false,
					"self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
					"watchCount": 1,
					"watchers": [
						{
							"accountId": "5b10a2844c20165700ede21g",
							"active": false,
							"displayName": "Mia Krystof",
							"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
						}
					]
				},
				"worklog": [
					{
						"author": {
							"accountId": "5b10a2844c20165700ede21g",
							"active": false,
							"displayName": "Mia Krystof",
							"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
						},
						"comment": {
							"content": [
								{
									"content": [
										{
											"text": "I did some work here.",
											"type": "text"
										}
									],
									"type": "paragraph"
								}
							],
							"type": "doc",
							"version": 1
						},
						"id": "100028",
						"issueId": "10002",
						"self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
						"started": "2021-08-19T05:11:52.832+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-08-19T05:11:52.832+0000",
						"visibility": {
							"type": "group",
							"value": "jira-developers"
						}
					}
				]
			},
			"id": "10002",
			"key": "ED-1",
			"self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
		}
	],
	"maxResults": 50,
	"startAt": 0,
	"total": 1,
	"warningMessages": [
		"The value 'bar' does not exist for the field 'foo'."
	]
}

​
Workflow Library Example

List Issues with Jira and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?