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

# IWorkspacesQuery

- 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

Query to retrieve available workspaces.

**Signature:**

```typescript
export interface IWorkspacesQuery 
```

## Methods

| Method | Description |
| --- | --- |
| [query()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesquery/index.md#iworkspacesqueryquery) | Executes the query and returns the result asynchronously. |
| [queryAllDescriptors()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesquery/index.md#iworkspacesqueryqueryalldescriptors) | Executes the query and returns all workspace descriptors. This is more efficient when you only need workspace metadata (id, title, etc.) and don't need the full workspace services. |
| [queryDescriptors()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesquery/index.md#iworkspacesqueryquerydescriptors) | Executes the query and returns workspace descriptors in a paged result. This is more efficient when you only need workspace metadata (id, title, etc.) and don't need the full workspace services. |
| [withFilter(filter)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesquery/index.md#iworkspacesquerywithfilter) | **_(ALPHA)_** Sets filter of workspaces by given attributes |
| [withLimit(limit)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesquery/index.md#iworkspacesquerywithlimit) | Sets a limit on how many items to retrieve at once. |
| [withOffset(offset)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesquery/index.md#iworkspacesquerywithoffset) | Sets a number of items to skip. |
| [withOptions(options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesquery/index.md#iworkspacesquerywithoptions) | **_(ALPHA)_** Sets additional options for the query. |
| [withParent(workspaceId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesquery/index.md#iworkspacesquerywithparent) | Sets a identifier of the parent workspace to get its children, otherwise the root workspace. |
| [withSearch(search)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesquery/index.md#iworkspacesquerywithsearch) | Sets a text to search. |

## Method details

### IWorkspacesQuery.query()

Executes the query and returns the result asynchronously.

**Signature:**

```typescript
query(): Promise<IWorkspacesQueryResult>;
```
**Returns:**

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

### IWorkspacesQuery.queryAllDescriptors()

Executes the query and returns all workspace descriptors. This is more efficient when you only need workspace metadata (id, title, etc.) and don't need the full workspace services.

**Signature:**

```typescript
queryAllDescriptors(): Promise<IWorkspaceDescriptor[]>;
```
**Returns:**

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

### IWorkspacesQuery.queryDescriptors()

Executes the query and returns workspace descriptors in a paged result. This is more efficient when you only need workspace metadata (id, title, etc.) and don't need the full workspace services.

**Signature:**

```typescript
queryDescriptors(): Promise<IPagedResource<IWorkspaceDescriptor>>;
```
**Returns:**

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

### IWorkspacesQuery.withFilter()

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

Sets filter of workspaces by given attributes

**Signature:**

```typescript
withFilter(filter: IWorkspacesQueryFilter): IWorkspacesQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| filter | [IWorkspacesQueryFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesqueryfilter/index.md) | an object of attributes and values to filter by |

**Returns:**

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

### IWorkspacesQuery.withLimit()

Sets a limit on how many items to retrieve at once.

**Signature:**

```typescript
withLimit(limit: number): IWorkspacesQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| limit | number | how many items to retrieve at most |

**Returns:**

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

### IWorkspacesQuery.withOffset()

Sets a number of items to skip.

**Signature:**

```typescript
withOffset(offset: number): IWorkspacesQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| offset | number | how many items to skip |

**Returns:**

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

### IWorkspacesQuery.withOptions()

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

Sets additional options for the query.

**Signature:**

```typescript
withOptions(options: IWorkspacesQueryOptions): IWorkspacesQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| options | [IWorkspacesQueryOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesqueryoptions/index.md) | an object of options to modify the query behavior |

**Returns:**

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

### IWorkspacesQuery.withParent()

Sets a identifier of the parent workspace to get its children, otherwise the root workspace.

**Signature:**

```typescript
withParent(workspaceId: string | undefined): IWorkspacesQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| workspaceId | string \| undefined | identifier of the parent workspace |

**Returns:**

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

### IWorkspacesQuery.withSearch()

Sets a text to search.

**Signature:**

```typescript
withSearch(search: string): IWorkspacesQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| search | string | text to search |

**Returns:**

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