queryLoyaltyAccounts( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a query to retrieve a list of accounts.

The queryLoyaltyAccounts() function builds a query to retrieve a list of events and returns a LoyaltyAccountsQueryBuilder object.

The returned object contains the query definition, which is typically used to run the query using the find() function.

You can refine the query by chaining LoyaltyAccountsQueryBuilder functions onto the query. LoyaltyAccountsQueryBuilder functions enable you to sort, filter, and control the results queryLoyaltyAccounts() returns.

queryLoyaltyAccounts() runs with these LoyaltyAccountsQueryBuilder defaults, which you can override:

  • skip(0)
  • limit(50)
  • descending("_createdDate")

The functions that are chained to queryLoyaltyAccounts() are applied in the order they're called. For example, if you apply ascending('points.balance') and then descending('points.earned'), the results are sorted first by the balance, and then, if there are multiple results with the same balance, the items are sorted by earned points.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
contactIdeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
memberIdeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
points.balanceeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
points.earnedeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
points.adjustedeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
points.redeemedeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
points.expiredeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
lastActivityDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
tier.ideq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
contact.ideq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
pointsExpiration.expirationDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
pointsExpiration.expiringPointsAmounteq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
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 queryLoyaltyAccounts(): LoyaltyAccountsQueryBuilder;
Request
This method does not take any parameters
Returns
JavaScript
import { accounts } from "@wix/loyalty"; async function queryLoyaltyAccounts() { const { items } = await accounts.queryLoyaltyAccounts().find(); }
Errors

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

Did this help?