Function: getSprint()

function getSprint(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  activatedDate?: string;
  autoStartStop?: boolean;
  completeDate?: string;
  endDate?: string;
  goal?: string;
  id?: number;
  incompleteIssuesDestinationId?: number;
  name?: string;
  originBoardId?: number;
  self?: string;
  startDate?: string;
  state?: string;
  synced?: boolean;
}>;

Defined in: src/server/api/sprint.ts:82

Returns a single sprint, for a given sprint Id. The sprint will only be returned if the user can view the board that the sprint was created on, or view at least one of the issues in the sprint.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ sprintId: number; }	-
parameters.sprintId	number	The Id of the requested sprint.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; activatedDate?: string; autoStartStop?: boolean; completeDate?: string; endDate?: string; goal?: string; id?: number; incompleteIssuesDestinationId?: number; name?: string; originBoardId?: number; self?: string; startDate?: string; state?: string; synced?: boolean; }>