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

# IUseWorkspaceUsersSearchResult

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: interface
- Stability: beta
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/presentation/automations/shared/hooks/useWorkspaceUsersSearch.ts

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

What [useWorkspaceUsersSearch()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.useworkspaceuserssearch/index.md) returns.

**Signature:**

```typescript
export interface IUseWorkspaceUsersSearchResult 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [isLoading](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iuseworkspaceuserssearchresult/index.md#iuseworkspaceuserssearchresultisloading) |  | boolean | **_(BETA)_** True while the search debounce window or a query is open. |
| [onActivate](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iuseworkspaceuserssearchresult/index.md#iuseworkspaceuserssearchresultonactivate) |  | () => void | **_(BETA)_** Starts the first fetch — nothing loads on mount until this is called (wire it to the control's open/focus). After an error it doubles as retry. |
| [onSearch](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iuseworkspaceuserssearchresult/index.md#iuseworkspaceuserssearchresultonsearch) |  | (search: string) => void | **_(BETA)_** Sets the search string; the query fires after a 300 ms debounce. |
| [search](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iuseworkspaceuserssearchresult/index.md#iuseworkspaceuserssearchresultsearch) |  | string | **_(BETA)_** The current, not yet debounced, search string. |
| [users](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iuseworkspaceuserssearchresult/index.md#iuseworkspaceuserssearchresultusers) |  | [IWorkspaceUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspaceuser/index.md)[] \| undefined | **_(BETA)_** The workspace users of the last settled query; undefined until the first query settles. |
| [usersError](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iuseworkspaceuserssearchresult/index.md#iuseworkspaceuserssearchresultuserserror) |  | [GoodDataSdkError](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.gooddatasdkerror/index.md) \| undefined | **_(BETA)_** The last query's error, if it failed. |

## Property details

### IUseWorkspaceUsersSearchResult.isLoading

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

True while the search debounce window or a query is open.

**Signature:**

```typescript
isLoading: boolean;
```

### IUseWorkspaceUsersSearchResult.onActivate

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Starts the first fetch — nothing loads on mount until this is called (wire it to the control's open/focus). After an error it doubles as retry.

**Signature:**

```typescript
onActivate: () => void;
```

### IUseWorkspaceUsersSearchResult.onSearch

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Sets the search string; the query fires after a 300 ms debounce.

**Signature:**

```typescript
onSearch: (search: string) => void;
```

### IUseWorkspaceUsersSearchResult.search

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

The current, not yet debounced, search string.

**Signature:**

```typescript
search: string;
```

### IUseWorkspaceUsersSearchResult.users

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

The workspace users of the last settled query; undefined until the first query settles.

**Signature:**

```typescript
users: IWorkspaceUser[] | undefined;
```

### IUseWorkspaceUsersSearchResult.usersError

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

The last query's error, if it failed.

**Signature:**

```typescript
usersError: GoodDataSdkError | undefined;
```