jira.js
    Preparing search index...

    Function queryWorkspaces

    • A workspace refers to a specific instance of an Atlassian product that is accessed through a unique URL. Whenever a user initiates or adds a new product instance, it results in the creation of a distinct workspace.

      This API will:

      • Return a paginated list of workspaces in a given org
      • Return more details about an organization's products (including product URL).

      Authorization scopes required: read:workspaces:admin

      Parameters

      • client: Client
      • parameters: {
            cursor?: string | null;
            limit?: number;
            orgId: string;
            query?: unknown;
            sort?:
                | {
                    field?: string;
                    order?: "desc"
                    | string & {}
                    | "asc";
                    [key: string]: unknown;
                }[]
                | null;
        }
        • Optionalcursor?: string | null

          A base-64 encoded continuation token used for pagination. When a cursor is provided in the request body, no other properties may be present.

        • Optionallimit?: number

          Specifies the maximum page size.

        • orgId: string

          Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.

        • Optionalquery?: unknown
        • Optionalsort?:
              | {
                  field?: string;
                  order?: "desc"
                  | string & {}
                  | "asc";
                  [key: string]: unknown;
              }[]
              | null
      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              data?: {
                  appType?: string;
                  attributes?: {
                      avatars?: Record<string, any>;
                      capacity?: number | null;
                      createdAt?: string | null;
                      createdBy?: string | null;
                      directory?: string;
                      hostUrl?: string | null;
                      icons?: Record<string, any>;
                      labels?: string[];
                      name?: string;
                      owner?: string | null;
                      realm?: string;
                      regions?: string[];
                      sandbox?:
                          | {
                              type?: (...) & (...)
                              | "NONE"
                              | "CHILD";
                              [key: string]: unknown;
                          }
                          | null;
                      status?: "offline"
                      | "online"
                      | "deprecated"
                      | string & {};
                      statusDetails?: string[];
                      type?: string;
                      typeKey?: string;
                      unit?: string;
                      updatedAt?: string | null;
                      usage?: number | null;
                      [key: string]: unknown;
                  };
                  id?: string;
                  links?: { self: string
                  | null; [key: string]: unknown };
                  relationships?: Record<string, any>;
                  type?: string;
                  [key: string]: unknown;
              }[];
              links?: {
                  next?: string
                  | null;
                  prev?: string | null;
                  self?: string | null;
                  [key: string]: unknown;
              };
              meta?: {
                  attributes?: unknown;
                  endIndex?: number
                  | null;
                  pageSize?: number;
                  startIndex?: number | null;
                  total?: number;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility

    On This Page
    Scopes