jira.js
    Preparing search index...

    Function getAllBoards

    • Returns all boards. This only includes boards that the user has permission to view.

      Deprecation notice: The required OAuth 2.0 scopes will be updated on February 15, 2024.

      • read:board-scope:jira-software, read:project:jira

      Parameters

      • client: Client
      • Optionalparameters: {
            accountIdLocation?: string;
            expand?:
                | string
                | string[]
                | string & {}
                | (string & {} | "permissions" | "admins")[];
            filterId?: number;
            includePrivate?: boolean;
            maxResults?: number;
            name?: string;
            negateLocationFiltering?: boolean;
            orderBy?: "name" | string & {} | "-name" | "+name";
            projectKeyOrId?: string;
            projectLocation?: string;
            projectTypeLocation?: string[];
            startAt?: number;
            type?: string & {} | "simple" | "scrum" | "kanban";
        }
        • OptionalaccountIdLocation?: string
        • Optionalexpand?: string | string[] | string & {} | (string & {} | "permissions" | "admins")[]

          List of fields to expand for each board. Valid values: admins, permissions.

        • OptionalfilterId?: number

          Filters results to boards that are relevant to a filter. Not supported for next-gen boards.

        • OptionalincludePrivate?: boolean

          Appends private boards to the end of the list. The name and type fields are excluded for security reasons.

        • OptionalmaxResults?: number

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

        • Optionalname?: string

          Filters results to boards that match or partially match the specified name.

        • OptionalnegateLocationFiltering?: boolean

          If set to true, negate filters used for querying by location. By default false.

        • OptionalorderBy?: "name" | string & {} | "-name" | "+name"

          Ordering of the results by a given field. If not provided, values will not be sorted. Valid values: name.

        • OptionalprojectKeyOrId?: string

          Filters results to boards that are relevant to a project. Relevance means that the jql filter defined in board contains a reference to a project.

        • OptionalprojectLocation?: string
        • OptionalprojectTypeLocation?: string[]

          Filters results to boards that are relevant to a project types. Support Jira Software, Jira Service Management. Valid values: software, service_desk. By default software.

        • OptionalstartAt?: number

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

        • Optionaltype?: string & {} | "simple" | "scrum" | "kanban"

          Filters results to boards of the specified types. Valid values: scrum, kanban, simple.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast: boolean;
              maxResults: number;
              startAt: number;
              total: number;
              values: {
                  admins?: {
                      groups?: { name?: string; self?: string; [key: string]: unknown }[];
                      users?: {
                          accountId?: string;
                          active?: boolean;
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          displayName?: string;
                          self?: string;
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  };
                  canEdit?: boolean;
                  favourite?: boolean;
                  id?: number;
                  isPrivate?: boolean;
                  location?: {
                      avatarURI?: string;
                      displayName?: string;
                      name?: string;
                      projectId?: number;
                      projectKey?: string;
                      projectName?: string;
                      projectTypeKey?: string;
                      userAccountId?: string;
                      userId?: number;
                      [key: string]: unknown;
                  };
                  name?: string;
                  self?: string;
                  type?: string & {}
                  | "simple"
                  | "scrum"
                  | "kanban";
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility