jira.js
    Preparing search index...

    Function getIssuesForBoard

    • Returns all issues from a board, for a given board Id. This only includes issues that the user has permission to view. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.

      Parameters

      • client: Client
      • parameters: {
            boardId: number;
            expand?: string;
            fields?: string | string[];
            jql?: string;
            maxResults?: number;
            startAt?: number;
            validateQuery?: boolean;
        }
        • boardId: number

          The Id of the board that contains the requested issues.

        • Optionalexpand?: string

          This parameter is currently not used.

        • Optionalfields?: string | string[]

          The list of fields to return for each issue. By default, all navigable and Agile fields are returned.

        • Optionaljql?: string

          Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.

        • OptionalmaxResults?: number

          The maximum number of issues to return per page. Default: 50.

        • OptionalstartAt?: number

          The starting index of the returned issues. Base index: 0.

        • OptionalvalidateQuery?: boolean

          Specifies whether to validate the JQL query or not. Default: true.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              expand?: string
              | null;
              issues?: {
                  changelog?: {
                      histories?: {
                          author?: (...) | (...);
                          created?: (...) | (...);
                          historyMetadata?: (...) | (...);
                          id?: (...) | (...);
                          items?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      maxResults?: number;
                      startAt?: number;
                      total?: number;
                      [key: string]: unknown;
                  };
                  editmeta?: {
                      fields?: Record<
                          string,
                          {
                              allowedValues?: (...)
                              | (...);
                              autoCompleteUrl?: (...) | (...);
                              defaultValue?: (...) | (...);
                              fieldId?: (...) | (...);
                              hasDefaultValue?: (...) | (...) | (...);
                              name?: (...) | (...);
                              operations?: (...) | (...);
                              required?: (...) | (...) | (...);
                              schema?: (...) | (...);
                              [key: string]: unknown;
                          },
                      >;
                      [key: string]: unknown;
                  };
                  fields?: Record<string, any>;
                  fieldsToInclude?: { included?: string[]; [key: string]: unknown };
                  id?: string;
                  key?: string;
                  names?: Record<string, string>;
                  operations?: { linkGroups?: LinkGroup[]; [key: string]: unknown };
                  properties?: {
                      properties?: Record<string, string>;
                      [key: string]: unknown;
                  };
                  renderedFields?: Record<string, any>
                  | null;
                  schema?: Record<
                      string,
                      {
                          custom?: string;
                          customId?: number;
                          items?: string;
                          system?: string;
                          type?: string;
                          [key: string]: unknown;
                      },
                  >;
                  self?: string;
                  transitionBeans?: {
                      description?: string;
                      fields?: Record<
                          string,
                          {
                              allowedValues?: ...;
                              autoCompleteUrl?: ...;
                              defaultValue?: ...;
                              fieldId?: ...;
                              hasDefaultValue?: ...;
                              name?: ...;
                              operations?: ...;
                              required?: ...;
                              schema?: ...;
                              [key: ...]: ...;
                          },
                      >;
                      id?: string;
                      name?: string;
                      opsbarSequence?: number;
                      to?: {
                          description?: (...)
                          | (...);
                          iconUrl?: (...) | (...);
                          id?: (...) | (...);
                          name?: (...) | (...);
                          self?: (...) | (...);
                          statusCategory?: (...) | (...);
                          statusColor?: (...) | (...);
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  }[];
                  transitions?: {
                      description?: string;
                      fields?: Record<
                          string,
                          {
                              allowedValues?: ...;
                              autoCompleteUrl?: ...;
                              defaultValue?: ...;
                              fieldId?: ...;
                              hasDefaultValue?: ...;
                              name?: ...;
                              operations?: ...;
                              required?: ...;
                              schema?: ...;
                              [key: ...]: ...;
                          },
                      >;
                      id?: string;
                      name?: string;
                      opsbarSequence?: number;
                      to?: {
                          description?: (...)
                          | (...);
                          iconUrl?: (...) | (...);
                          id?: (...) | (...);
                          name?: (...) | (...);
                          self?: (...) | (...);
                          statusCategory?: (...) | (...);
                          statusColor?: (...) | (...);
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  }[];
                  versionedRepresentations?: Record<string, any>;
                  [key: string]: unknown;
              }[];
              maxResults?: number;
              maxResultWindow?: number;
              names?: Record<string, string>
              | null;
              schema?:
                  | Record<
                      string,
                      {
                          custom?: string;
                          customId?: number;
                          items?: string;
                          system?: string;
                          type?: string;
                          [key: string]: unknown;
                      },
                  >
                  | null;
              startAt?: number;
              total?: number;
              warningMessages?: string[]
              | null;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility