searchAccounts( )


Retrieves a list of accounts, given the provided filters and search capabilities. Search is executed on the account's name and email values.

PropertyCapabilitiesFilters
_updatedDateSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
contact._idSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
contact.displayNameSearch: ✗
Aggregate: ✗
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
contact.emailSearch:
Aggregate: ✗
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
contact.nameSearch:
Aggregate: ✗
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
lastActivityDateSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
points.balanceSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
points.redeemedSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
pointsExpiration.expirationDateSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Read Loyalty
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
searchCursorSearchRequired

Search options.

Returns
Return Type:Promise<SearchAccountsResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?