Get a Single Issue
GET {{baseUrl}}/rest/api/3/issue/:issueIdOrKey?fields=*all&fieldsByKeys=false
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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields | string | 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: |
*allReturns all fields.*navigableReturns navigable fields.- Any issue field, prefixed with a minus to exclude.
Examples:
summary,commentReturns only the summary and comments fields.-descriptionReturns all (default) fields except description.*navigable,-commentReturns all navigable fields except comment.
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. |
| fieldsByKeys | boolean | | 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. |
| expand | string | | Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include:
-
renderedFieldsReturns field values rendered in HTML format. -
namesReturns the display name of each field. -
schemaReturns the schema describing a field type. -
transitionsReturns all possible transitions for the issue. -
editmetaReturns information about how each field can be edited. -
changelogReturns a list of recent updates to an issue, sorted by date, starting from the most recent. -
versionedRepresentationsReturns 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, thefieldsparameter is ignored. | |properties| string | | A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: -
*allReturns all issue properties. -
Any issue property key, prefixed with a minus to exclude.
Examples:
*allReturns all properties.*all,-prop1Returns all properties exceptprop1.prop1,prop2Returnsprop1andprop2properties.
This parameter may be specified multiple times. For example, properties=prop1,prop2& properties=prop3. |
| updateHistory | boolean | | 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. |