jira.js
    Preparing search index...

    Function getOrganizations

    • This method returns a list of organizations in the Jira Service Management instance. Use this method when you want to present a list of organizations or want to locate an organization by name.

      Permissions required: Any. However, to fetch organizations based on accountId the user must have a Service Desk agent license.

      Response limitations: If the user is a customer, only those organizations of which the customer is a member are listed.

      Parameters

      • client: Client
      • Optionalparameters: { accountId?: string; limit?: number; start?: number }
        • OptionalaccountId?: string

          The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

        • Optionallimit?: number

          The maximum number of organizations to return per page. Default: 50. See the Pagination section for more details.

        • Optionalstart?: number

          The starting index of the returned objects. Base index: 0. See the Pagination section for more details.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              _expands?: string[];
              _links?: {
                  base?: string;
                  context?: string;
                  next?: string;
                  prev?: string;
                  self?: string;
                  [key: string]: unknown;
              };
              isLastPage?: boolean;
              limit?: number;
              size?: number;
              start?: number;
              values?: {
                  _links?: { self?: string; [key: string]: unknown };
                  created?: {
                      epochMillis?: number;
                      friendly?: string;
                      iso8601?: string;
                      jira?: string;
                      [key: string]: unknown;
                  };
                  id?: string;
                  name?: string;
                  scimManaged?: boolean;
                  uuid?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility