Get Issue
Returns the details for an issue.
The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is not returned. The issue key returned in the response is the key of the issue found.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
External Documentation
To learn more, visit the Jira documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Expand | Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: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.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 for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the fields parameter is ignored. |
| Fields | A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values: `all Returns all fields.<br/> * navigable` Returns navigable fields.Any issue field, prefixed with a minus to exclude. Examples: summary,comment Returns only the summary and comments fields.-description Returns all (default) fields except description.`navigable,-comment Returns all navigable fields except comment.<br/><br/>This parameter may be specified multiple times. For example,fields=field1,field2& fields=field3`.Note: All fields are returned by default. This differs from Search for issues using JQL (GET) and Search for issues using JQL (POST) where the default is all navigable fields. |
| Issue ID Or Key | The ID or key of the issue. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Fields By Keys | Whether fields in fields are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID. |
| Properties | A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: `all Returns all issue properties.<br/> * Any issue property key, prefixed with a minus to exclude.<br/><br/>Examples:<br/><br/> * all` Returns all properties.*all,-prop1 Returns all properties except prop1.* prop1,prop2 Returns prop1 and prop2 properties.This parameter may be specified multiple times. For example, properties=prop1,prop2& properties=prop3. |
| Update History | Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira. This also populates the JQL issues search lastViewed field. |
Example Output
{
"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"
}
Workflow Library Example
Get Issue with Jira and Send Results Via Email
Preview this Workflow on desktop