jira.js
    Preparing search index...

    Function getProjects

    • Returns all projects that are associated with the board, for the given board ID. If the user does not have permission to view the board, no projects will be returned at all. Returned projects are ordered by the name.

      A project is associated with a board if the board filter contains reference the project or there is an issue from the project that belongs to the board.

      The board filter contains reference the project only if JQL query guarantees that returned issues will be returned from the project set defined in JQL. For instance the query project in (ABC, BCD) AND reporter = admin have reference to ABC and BCD projects but query project in (ABC, BCD) OR reporter = admin doesn't have reference to any project.

      An issue belongs to the board if its status is mapped to the board's column. Epic issues do not belongs to the scrum boards.

      Parameters

      • client: Client
      • parameters: { boardId: number; maxResults?: number; startAt?: number }
        • boardId: number

          The ID of the board that contains returned projects.

        • OptionalmaxResults?: number

          The maximum number of projects 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 projects. Base index: 0. See the 'Pagination' section at the top of this page for more details.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast?: boolean;
              maxResults?: number;
              startAt?: number;
              total?: number;
              values?: {
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  id?: string;
                  key?: string;
                  name?: string;
                  projectCategory?: {
                      description?: string;
                      id?: string;
                      name?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  projectTypeKey?: | string & {}
                  | "software"
                  | "service_desk"
                  | "business"
                  | "product_discovery"
                  | "customer_service";
                  self?: string;
                  simplified?: boolean;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility