Get Issue

Options

Issue ID or Key

The ID or key of the issue.

Set Fields

Enable to set the optional field Fields

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.
• *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.

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.

Set Fields by Keys

Enable to set the optional field Fields by Keys

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.

Set Expand

Enable to set the optional field Expand

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.

Set Properties

Enable to set the optional field Properties

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.
• Any issue property key, prefixed with a minus to exclude.

Examples:

• *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.

Set Update History

Enable to set the optional field Update History

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.

Set Fail Fast

Enable to set the optional field Fail Fast

Fail Fast

Whether to fail the request quickly in case of an error while loading fields for an issue. For failFast=true, if one field fails, the entire operation fails. For failFast=false, the operation will continue even if a field fails. It will return a valid response, but without values for the failed field(s).

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

• Changelog: Details of changelogs associated with the issue.
• Editmeta: The metadata for the fields on the issue that can be amended.
• Expand: Expand options that include additional issue details in the response.
• Fields:
• Fields to Include:
• Id: The ID of the issue.
• Key: The key of the issue.
• Names: The ID and name of each field present on the issue.
• Operations: The operations that can be performed on the issue.
• Properties: Details of the issue properties identified in the request.
• Rendered Fields: The rendered value of each field present on the issue.
• Schema: The schema describing each field present on the issue.
• Self: The URL of the issue details.
• Transitions: The transitions that can be performed on the issue.
• Versioned Representations: The versions of each field on the issue.

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers