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

This function requires elevated permissions and runs only on the backend and on dashboard pages.

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.v2"; import { webMethod, Permissions } from "wix-web-module"; import { elevate } from "wix-auth"; /* Sample options value: * { * "options": null * } */ const elevatedCountAccounts = elevate(accounts.countAccounts); export const countAccounts = webMethod(Permissions.Anyone, async (options) => { try { const result = await elevatedCountAccounts(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?