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

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

# Function: searchBmUsers()

> **searchBmUsers**(`instance`, `options`): `Promise`\<\{ \}\>

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

Searches users on an instance.

Supports either a fully-formed OCAPI query (`options.query`) or convenience flags
(`searchPhrase`, `login`, `email`, `locked`, `disabled`) which are combined into a
`bool_query`. If no criteria are provided a `match_all_query` is used.

## Parameters

### instance

[`B2CInstance`](../../../instance/classes/B2CInstance.md)

B2C instance

### options

[`SearchBmUsersOptions`](../interfaces/SearchBmUsersOptions.md) = `{}`

Search options

## Returns

`Promise`\<\{ \}\>

User search result