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.

Admin Method

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Loyalty
Manage Loyalty
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
optionsCountAccountsOptions
Returns
Return Type:Promise<CountAccountsResponse>
Was this helpful?
Yes
No