listAccounts( )


Retrieves a list of loyalty accounts, given the provided filters.

The listAccounts() function returns a Promise that resolves to a list of loyalty accounts.

You can retrieve selected loyalty accounts with an array of contactIds or retrieve a list of all of a site's loyalty accounts with an empty request parameter. Use the cursorPaging parameters to limit how many items load at a time.

Note: Only visitors with Manage Loyalty permissions can retrieve loyalty 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
Method Parameters
optionsListAccountsOptions

Options to use when retrieving a list of loyalty accounts.

Returns
Return Type:Promise<ListAccountsResponse>
Did this help?