Interface GetAllSprints

interface GetAllSprints {
    boardId: number;
    maxResults?: number;
    startAt?: number;
    state?: string;
}

Properties

boardId maxResults? startAt? state?

Properties

boardId

boardId: number

The ID of the board that contains the requested sprints.

Optional maxResults

maxResults?: number

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

Optional startAt

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.

Optional state

state?: string

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

Settings

Member Visibility

Theme

On This Page

boardIdmaxResultsstartAtstate