ATatlassian
Board

Get all sprints

Changed on

Returns all sprints from a board, for a given board ID. This only includes sprints that the user has permission to view.

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

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/sprint
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:sprint:jira-software

Path parameters

boardIdinteger required

The ID of the board that contains the requested sprints.

Query parameters

startAtinteger

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

maxResultsinteger

The maximum number of sprints to return per page. See the 'Pagination' section at the top of this page for more details.

stateobject

Filters results to sprints in specified states. Valid values: future, active, closed. You can define multiple states separated by commas, e.g. state=active,closed

Response

Returns the requested sprints, at the specified page of the results. Sprints will be ordered first by state (i.e. closed, active, future) then by their position in the backlog.

Changes