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

# IWorkspaceUserGroupsQuery

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

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

Service to query user groups for current workspace

**Signature:**

```typescript
export interface IWorkspaceUserGroupsQuery 
```

## Methods

| Method | Description |
| --- | --- |
| [query(options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceusergroupsquery/index.md#iworkspaceusergroupsqueryquery) | **_(ALPHA)_** Starts the user groups query. |

## Method details

### IWorkspaceUserGroupsQuery.query()

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

Starts the user groups query.

**Signature:**

```typescript
query(options: IWorkspaceUserGroupsQueryOptions): Promise<IWorkspaceUserGroupsQueryResult>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| options | [IWorkspaceUserGroupsQueryOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceusergroupsqueryoptions/index.md) |  |

**Returns:**

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

promise with a list of all user groups matching the specified options