Name

Description

Data Type

Required?

Example

Connected account

The connected account to use for the request

Connected Account

Yes

Issue key

Text (Short)

Yes

Simplify?

Whether to return a simplified version of the response instead of the raw data

True/False

No

Expand

Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list.

Text (Short)

No

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

Text (Long)

No

Fields by key?

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

True/False

No

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

Text (Long)

No

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

True/False

No

Name

Description

Data Type

Required?

Example

JSON Output

JSON output returned by the API

Text (Long)

No

Name

Description

Success

This status is selected if the job has successfully completed.

Unsuccessful

This status is selected if the job has completed unsuccessfully.