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

# IWorkspaceUserGroupsQueryOptions

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

Configuration options for querying user groups

**Signature:**

```typescript
export interface IWorkspaceUserGroupsQueryOptions 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [limit?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceusergroupsqueryoptions/index.md#iworkspaceusergroupsqueryoptionslimit) |  | number | **_(ALPHA)_** _(Optional)_ Specify number of items per page. |
| [offset?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceusergroupsqueryoptions/index.md#iworkspaceusergroupsqueryoptionsoffset) |  | number | **_(ALPHA)_** _(Optional)_ Specify (zero-based) starting offset for the results. |
| [search?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceusergroupsqueryoptions/index.md#iworkspaceusergroupsqueryoptionssearch) |  | string | **_(ALPHA)_** _(Optional)_ String prefix filter |

## Property details

### IWorkspaceUserGroupsQueryOptions.limit

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

Specify number of items per page.

**Signature:**

```typescript
limit?: number;
```

### IWorkspaceUserGroupsQueryOptions.offset

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

Specify (zero-based) starting offset for the results.

**Signature:**

```typescript
offset?: number;
```

### IWorkspaceUserGroupsQueryOptions.search

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

String prefix filter

**Signature:**

```typescript
search?: string;
```