Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1310566642.9 KB
Epic

Get issues for epic (enhanced)

Returns all issues that belong to the epic, for the given epic ID. Result pagination is token based, using nextPageToken and maxResults. This only includes issues that the user has permission to view. Issues returned from this resource include Software project fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. Note: If you are querying a Team Managed project, do not use this operation. Instead, search for issues that belong to an epic by using the Search for issues using JQL enhanced search operation in the Jira platform REST API. Build your JQL query using the parent clause. For more information on the parent JQL field, see Advanced searching.

get/rest/software/1.0/epic/{epicIdOrKey}/issue

Path parameters

epicIdOrKeystring required

The ID or key of the epic that contains the requested issues.

Query parameters

nextPageTokenstring

The token for a page to fetch that is not the first page. The first page has a nextPageToken of null. Use the nextPageToken to fetch the next page of issues.

Note: The nextPageToken field is not included in the response for the last page, indicating there is no next page.

maxResultsinteger

The maximum number of items to return per page. To manage page size, the API may return fewer items per page where there is a large number of fields or properties returned. It returns max 5000 issues.

reconcileIssuesinteger[]

Strong consistency issue IDs to be reconciled with search results. Accepts max 50 IDs. This list of IDs should be consistent with each paginated request across different pages.

jqlstring

Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.

validateQueryboolean

Specifies whether to validate the JQL query or not. Default: true.

fieldsobject[]

The list of fields to return for each issue. By default, all navigable and Software project fields are returned.

expandstring

A comma-separated list of the parameters to expand.

Response

Returns the requested issues, at the specified page of the results.

expandstring

Expand options that include additional search result details in the response.

isLastboolean

Indicates whether this is the last page of the paginated response.

namesobject

The ID and name of each field in the search results.

nextPageTokenstring

Continuation token to fetch the next page. If this result represents the last or only page, this token will be null.

schemaobject

The schema describing the field types in the search results.

warningMessagesstring[]

Any warnings related to the JQL query.