> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IWorkspacesQueryFactory

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/workspace/index.ts

Factory providing creating queries used to get available workspaces.

**Signature:**

```typescript
export interface IWorkspacesQueryFactory 
```

## Methods

| Method | Description |
| --- | --- |
| [createWorkspace(definition)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesqueryfactory/index.md#iworkspacesqueryfactorycreateworkspace) | **_(ALPHA)_** Creates a new workspace. |
| [forCurrentUser()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesqueryfactory/index.md#iworkspacesqueryfactoryforcurrentuser) | Creates a query for workspaces available to the user currently logged in. |
| [forUser(userId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesqueryfactory/index.md#iworkspacesqueryfactoryforuser) | Creates a query for workspaces available to the specified user. |

## Method details

### IWorkspacesQueryFactory.createWorkspace()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Creates a new workspace.

**Signature:**

```typescript
createWorkspace(definition: IWorkspaceDefinition): Promise<IWorkspaceDescriptor>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| definition | [IWorkspaceDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedefinition/index.md) | definition of the workspace |

**Returns:**

Promise&lt;[IWorkspaceDescriptor](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedescriptor/index.md)&gt;

descriptor of the created workspace

### IWorkspacesQueryFactory.forCurrentUser()

Creates a query for workspaces available to the user currently logged in.

**Signature:**

```typescript
forCurrentUser(): IWorkspacesQuery;
```
**Returns:**

[IWorkspacesQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesquery/index.md)

### IWorkspacesQueryFactory.forUser()

Creates a query for workspaces available to the specified user.

**Signature:**

```typescript
forUser(userId: string): IWorkspacesQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| userId | string | id of the user to retrieve workspaces for |

**Returns:**

[IWorkspacesQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesquery/index.md)
