countAccounts( )

Retrieves the count of found accounts, given the provided filters and search capabilities.

This endpoint can help find the total count of accounts when used alongside Search Accounts.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Loyalty
Read Loyalty
Learn more about app permissions.
Method Declaration
Copy
function countAccounts(
  options: CountAccountsOptions,
): Promise<CountAccountsResponse>;
Method Parameters
optionsCountAccountsOptions
Returns
Return Type:Promise<CountAccountsResponse>
JavaScript
import { accounts } from "@wix/loyalty";

/* Sample options value:
 * {
 *     "options": null
 * }
 */

export async function countAccounts(options) {
  try {
    const result = await accounts.countAccounts(options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}

/* Promise resolves to:
 * {
 *   "count": 3
 * }
 */
Errors

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

Did this help?