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

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

# Interface: SearchBmUsersOptions

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:84](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/5f9b348d598ad92ddf670da42e944b204395bdc8/packages/b2c-tooling-sdk/src/operations/bm-users/users.ts#L84)

Options for searching BM users.

Searchable fields per the Data API spec: login, email, first_name, last_name,
external_id, last_login_date, is_locked, is_disabled.

## Properties

### count?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:107](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/5f9b348d598ad92ddf670da42e944b204395bdc8/packages/b2c-tooling-sdk/src/operations/bm-users/users.ts#L107)

Number of items to return (default 25)

***

### disabled?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:99](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/5f9b348d598ad92ddf670da42e944b204395bdc8/packages/b2c-tooling-sdk/src/operations/bm-users/users.ts#L99)

Match disabled users

***

### email?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:95](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/5f9b348d598ad92ddf670da42e944b204395bdc8/packages/b2c-tooling-sdk/src/operations/bm-users/users.ts#L95)

Match users with a specific email

***

### locked?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:97](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/5f9b348d598ad92ddf670da42e944b204395bdc8/packages/b2c-tooling-sdk/src/operations/bm-users/users.ts#L97)

Match locked users

***

### login?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:93](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/5f9b348d598ad92ddf670da42e944b204395bdc8/packages/b2c-tooling-sdk/src/operations/bm-users/users.ts#L93)

Match users with a specific login

***

### query?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:89](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/5f9b348d598ad92ddf670da42e944b204395bdc8/packages/b2c-tooling-sdk/src/operations/bm-users/users.ts#L89)

Pre-built OCAPI query object (e.g. `{text_query: {fields: ['login'], search_phrase: 'foo'}}`).
If omitted, one is built from the convenience flags below.

***

### searchPhrase?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:91](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/5f9b348d598ad92ddf670da42e944b204395bdc8/packages/b2c-tooling-sdk/src/operations/bm-users/users.ts#L91)

Free-text phrase searched across login/email/first_name/last_name

***

### select?

> `optional` **select**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:109](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/5f9b348d598ad92ddf670da42e944b204395bdc8/packages/b2c-tooling-sdk/src/operations/bm-users/users.ts#L109)

Property selector (default returns shallow user fields)

***

### sortBy?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:101](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/5f9b348d598ad92ddf670da42e944b204395bdc8/packages/b2c-tooling-sdk/src/operations/bm-users/users.ts#L101)

Field to sort by (e.g. 'login', 'email', 'last_login_date')

***

### sortOrder?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:103](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/5f9b348d598ad92ddf670da42e944b204395bdc8/packages/b2c-tooling-sdk/src/operations/bm-users/users.ts#L103)

Sort direction

***

### start?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:105](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/5f9b348d598ad92ddf670da42e944b204395bdc8/packages/b2c-tooling-sdk/src/operations/bm-users/users.ts#L105)

Start index (default 0)