Function: queryWorkspaces()

function queryWorkspaces(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
  meta?: {
   [key: string]: unknown;
     attributes?: unknown;
     endIndex?: number | null;
     pageSize?: number;
     startIndex?: number | null;
     total?: number;
  };
}>;

Defined in: src/admin/api/workspaces.ts:18

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).

Scopes

Authorization scopes required: read:workspaces:admin

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ cursor?: string | null; limit?: number; orgId: string; query?: QueryVariantsInput; sort?: object[] | null; }	-
parameters.cursor?	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.
parameters.limit?	number	Specifies the maximum page size.
parameters.orgId?	string	Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.query?	QueryVariantsInput	-
parameters.sort?	object[] | null	-
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; meta?: { [key: string]: unknown; attributes?: unknown; endIndex?: number | null; pageSize?: number; startIndex?: number | null; total?: number; }; }>