jira.js
    Preparing search index...

    Function queryTeams

    • This returns a list of all teams contained under an organization. This may be used as an option to export teams data within your organization.

      Parameters

      • client: Client
      • parameters: { cursor?: string; orgId: string; siteId?: string; size?: number }
        • Optionalcursor?: string

          An optional cursor token. Leave off for the first request.

        • orgId: string

          The ID of the organisation the teams are to be retrieved from.

        • OptionalsiteId?: string

          [Optional] The ID of the site to retrieve teams which are site scoped. Please note that if the org is site-scoped, teams will not be included in response if siteId is not provided. [Deprecated] Omitting siteId is deprecated. With the introduction of Units, orgId alone is no longer sufficient to resolve the scope of teams. Always provide a valid siteId to ensure this operation continues to work in the future.

        • Optionalsize?: number

          The page size for the number of teams to return (max 300)

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              cursor?: string
              | null;
              entities: {
                  creatorId?: string | null;
                  description: string;
                  displayName: string;
                  externalReference?:
                      | {
                          id: string;
                          source: string & {}
                          | "ATLASSIAN_GROUP"
                          | "HRIS";
                          [key: string]: unknown;
                      }
                      | null;
                  organizationId: string;
                  state: string & {}
                  | "ACTIVE"
                  | "ARCHIVED";
                  teamId: string;
                  teamType:
                      | string & {}
                      | "EXTERNAL"
                      | "OPEN"
                      | "MEMBER_INVITE"
                      | "ORG_ADMIN_MANAGED";
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility