BoardSprints

Retrieves a list of sprints associated with a specific agile board, including active, future, and closed sprints.

Table Specific Information

The cmdlet uses the Jira API to process some of the filters. The cmdlet processes other filters within the cmdlet.

For example, the following queries are processed server side.

SELECT * FROM BoardSprints WHERE BoardId = 122

Using BoardId:

SELECT * FROM BoardSprints WHERE BoardId IN (12, 42)

Boards of type 'kanban' do not support sprints, so you can retrieve all the sprints faster if you use a query like the following:

SELECT * FROM BoardSprints WHERE BoardId IN (SELECT Id FROM Boards WHERE Type != 'kanban')


Name	Type	References	SupportedOperators	Platform	Description
Id [KEY]	Integer			Common	The unique identifier of the sprint used to reference the sprint within Jira.
BoardId [KEY]	Integer	Boards.Id	=,IN	Common	The identifier of the board the sprint belongs to. Sprints are created and managed within the context of a board.
Name	String			Common	The user-defined name of the sprint, typically representing a time-boxed development iteration.
State	String		=	Common	The current lifecycle state of the sprint. Valid values include 'future', 'active', and 'closed', with transitions limited to 'future' → 'active' → 'closed'. The allowed values are future, active, closed.
Goal	String			Common	The goal or objective defined for the sprint, often used to communicate the sprint's focus or expected outcome.
OriginBoardId	Integer	Boards.Id	=	Common	The identifier of the board where the sprint was initially created. This value is read-only and cannot be changed.
StartDate	Datetime			Common	The date and time when the sprint was started, marking the beginning of the sprint duration.
EndDate	Datetime			Common	The scheduled end date and time of the sprint, representing the planned close of the sprint window.
CompleteDate	Datetime			Common	The actual completion date of the sprint. This field is set when the sprint is officially closed.