Function: getAllSprints()

function getAllSprints(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  startAt?: number;
  total?: number;
  values?: object[];
}>;

Defined in: src/agile/api/board.ts:668

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

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ boardId: number; maxResults?: number; startAt?: number; state?: "active" | "closed" | string & object | "future"; }	-
parameters.boardId	number	The ID of the board that contains the requested sprints.
parameters.maxResults?	number	The maximum number of sprints to return per page. See the 'Pagination' section at the top of this page for more details.
parameters.startAt?	number	The starting index of the returned sprints. Base index: 0. See the 'Pagination' section at the top of this page for more details.
parameters.state?	"active" | "closed" | string & object | "future"	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
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; startAt?: number; total?: number; values?: object[]; }>