v1

latestOpenAPI 3.0.1Apache 2.02026-07-1310566642.9 KB
Sprint

Get issues for sprint

Returns all issues in a sprint, for a given sprint ID. This only includes issues that the user has permission to view. By default, the returned issues are ordered by rank.

get/rest/agile/1.0/sprint/{sprintId}/issue

Path parameters

sprintIdinteger required

The ID of the sprint that contains the requested issues.

Query parameters

startAtinteger

The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.

maxResultsinteger

The maximum number of issues to return per page. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated.

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