jira.js
    Preparing search index...

    Function getProjects

    • Returns all projects that are associated with the board, for the given board Id. A project is associated with a board only if the board filter explicitly filters issues by the project and guaranties that all issues will come for one of those projects e.g. board's filter with "project in (PR-1, PR-1) OR reporter = admin" jql Projects are returned only if user can browse all projects that are associated with the board. Note, 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.

      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. Default: 50. 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?: Record<string, string>;
                  id?: string;
                  key?: string;
                  name?: string;
                  projectCategory?: {
                      description?: string;
                      id?: string;
                      name?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  projectTypeKey?: string;
                  self?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility