---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../../modules.md) / [operations/bm-users](../index.md) / SearchUsersOptions

# Interface: SearchUsersOptions

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:69](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/types.ts#L69)

Portable user search criteria supported by both backends.

## Extends

- [`ListUsersOptions`](ListUsersOptions.md)

## Properties

### count?

> `optional` **count**: `number`

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:65](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/types.ts#L65)

#### Inherited from

[`ListUsersOptions`](ListUsersOptions.md).[`count`](ListUsersOptions.md#count)

***

### disabled?

> `optional` **disabled**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:76](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/types.ts#L76)

***

### email?

> `optional` **email**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:74](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/types.ts#L74)

***

### locked?

> `optional` **locked**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:75](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/types.ts#L75)

***

### login?

> `optional` **login**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:73](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/types.ts#L73)

***

### query?

> `optional` **query**: `unknown`

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:71](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/types.ts#L71)

Raw OCAPI query. In auto mode this deliberately selects the OCAPI fallback.

***

### searchPhrase?

> `optional` **searchPhrase**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:72](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/types.ts#L72)

***

### sortBy?

> `optional` **sortBy**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:77](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/types.ts#L77)

***

### sortOrder?

> `optional` **sortOrder**: `"asc"` \| `"desc"`

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:78](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/types.ts#L78)

***

### start?

> `optional` **start**: `number`

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/types.ts:64](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/operations/bm-users/types.ts#L64)

#### Inherited from

[`ListUsersOptions`](ListUsersOptions.md).[`start`](ListUsersOptions.md#start)