Sign in
latestOpenAPI 3.0.1Apache 2.02026-08-146089132.3 MB

acec950ef0bc

Issues

Bulk fetch issues

Returns the details for a set of requested issues.

By default you can request up to 100 issues in a single call. You can request up to 1000 issues in a single call when the request is shaped so that it can be served efficiently, that is, when all of the following are true:

  • the fields parameter explicitly names at least one field to include — a request that contains only exclusions is not eligible, and neither are the *all and *navigable wildcards or the default navigable field set, because the number of resolved fields depends on the site's configuration;
  • no more than 100 fields are explicitly included;
  • none of the included fields returns multiple values (for example comment, worklog, or attachment); and
  • the expand parameter does not include changelog, editmeta, operations, renderedFields, transitions, or versionedRepresentations.

Requests that do not meet all of these conditions can include at most 100 issues; larger requests are rejected with a 400 error.

Each 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.

Issues will be returned in ascending id order. If there are errors, Jira will return a list of issues which couldn't be fetched along with error messages.

This operation can be accessed anonymously.

Permissions required: Issues are included in the response where the user has:

post/rest/api/2/issue/bulkfetch

Request body

expandstring[]

Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where expand is specified, expand is defined as a list of values. The expand options are:

  • 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.
  • operations Returns all possible operations 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. This returns a maximum of 40 changelogs. If you require more, please refer to Bulk fetch changelogs.
  • versionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.

To request up to 1000 issues in a single call, do not include changelog, editmeta, operations, renderedFields, transitions, or versionedRepresentations in expand. Requests that include any of these can include at most 100 issues; larger requests are rejected with a 400 error.

fieldsstring[]

A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include:

  • *all Returns all fields.
  • *navigable Returns navigable fields.
  • Any issue field, prefixed with a minus to exclude.

The default is *navigable.

Examples:

  • summary,comment Returns the summary and comments fields only.
  • -description Returns all navigable (default) fields except description.
  • *all,-comment Returns all fields except comments.

Multiple fields parameters can be included in a request.

Note: All navigable fields are returned by default. This differs from GET issue where the default is all fields.

To request up to 1000 issues in a single call, explicitly list the fields you need: at least one field must be a positive include (a request containing only exclusions is not eligible), the *all and *navigable wildcards and the default navigable field set are not eligible for the higher limit, no more than 100 fields may be listed, and none of the included fields returns multiple values (for example comment, worklog, or attachment). Requests that do not meet these conditions can include at most 100 issues; larger requests are rejected with a 400 error.

fieldsByKeysboolean

Reference fields by their key (rather than ID). The default is false.

issueIdsOrKeysstring[] required

An array of issue IDs or issue keys to fetch. You can mix issue IDs and keys in the same query. You can request up to 100 issues per call. Requests can include up to 1000 issues per call when they meet all of the conditions described for the fields and expand parameters. Requests that exceed the applicable limit are rejected with a 400 error.

propertiesstring[]

A list of issue property keys of issue properties to be included in the results. A maximum of 5 issue property keys can be specified.

Response

Returned if the request is successful. A response may contain both successful issues and issue errors.