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

# IWorkspaceUsersQuery

- 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/users/index.ts

Service to query users for current workspace

**Signature:**

```typescript
export interface IWorkspaceUsersQuery 
```

## Methods

| Method | Description |
| --- | --- |
| [query()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceusersquery/index.md#iworkspaceusersqueryquery) | Starts the users query. |
| [queryAll()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceusersquery/index.md#iworkspaceusersqueryqueryall) | Starts the users query. |
| [withOptions(options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceusersquery/index.md#iworkspaceusersquerywithoptions) | Allows to specify advanced options for the users query. |

## Method details

### IWorkspaceUsersQuery.query()

Starts the users query.

**Signature:**

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

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

promise of first page of the results

### IWorkspaceUsersQuery.queryAll()

Starts the users query.

**Signature:**

```typescript
queryAll(): Promise<IWorkspaceUser[]>;
```
**Returns:**

Promise&lt;[IWorkspaceUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspaceuser/index.md)[]&gt;

promise with a list of all users matching the specified options

### IWorkspaceUsersQuery.withOptions()

Allows to specify advanced options for the users query.

**Signature:**

```typescript
withOptions(options: IWorkspaceUsersQueryOptions): IWorkspaceUsersQuery;
```

#### Parameters

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

**Returns:**

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

users query
