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

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
Request
This method does not take any parameters
Returns
Did this help?