v1

latestOpenAPI 3.0.1Apache 2.02026-07-1310566642.9 KB
Board

Get issues for backlog

Returns all issues from the board's backlog, for the given board ID. This only includes issues that the user has permission to view. The backlog contains incomplete issues that are not assigned to any future or active sprint. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.

get/rest/agile/1.0/board/{boardId}/backlog

Path parameters

boardIdinteger required

The ID of the board that has the backlog containing 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. Default: 50. 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

This parameter is currently not used.

Response

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

expandstring

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

maxResultsinteger

The maximum number of results that could be on the page.

namesobject

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

schemaobject

The schema describing the field types in the search results.

startAtinteger

The index of the first item returned on the page.

totalinteger

The number of results on the page.

warningMessagesstring[]

Any warnings related to the JQL query.