GET /rest/api/2/issue/{issueIdOrKey}
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.
Servers
- https://your-domain.atlassian.net
Path parameters
Name | Type | Required | Description |
---|---|---|---|
issueIdOrKey |
String | Yes |
The ID or key of the issue. |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
fieldsByKeys |
Boolean | No |
Whether fields in Default value: false |
properties[] |
Array | No |
A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values:
Examples:
This parameter may be specified multiple times. For example, |
updateHistory |
Boolean | No |
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 Default value: false |
expand |
String | No |
Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include:
|
fields[] |
Array | No |
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:
Examples:
This parameter may be specified multiple times. For example, 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. |
failFast |
Boolean | No |
Whether to fail the request quickly in case of an error while loading fields for an issue. For Default value: false |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.