jira.js
    Preparing search index...

    Function getAllSprints

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

      Parameters

      • client: Client
      • parameters: {
            boardId: number;
            maxResults?: number;
            startAt?: number;
            state?: "active" | "closed" | string & {} | "future";
        }
        • boardId: number

          The ID of the board that contains the requested sprints.

        • OptionalmaxResults?: number

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

        • OptionalstartAt?: number

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

        • Optionalstate?: "active" | "closed" | string & {} | "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

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast?: boolean;
              maxResults?: number;
              startAt?: number;
              total?: number;
              values?: {
                  completeDate?: Date;
                  createdDate?: Date;
                  endDate?: Date;
                  goal?: string;
                  id?: number;
                  name?: string;
                  originBoardId?: number;
                  self?: string;
                  startDate?: Date;
                  state: "active"
                  | "closed"
                  | string & {}
                  | "future";
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility