queryUserMembers( )


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 user members.

The queryUserMembers() function builds a query to retrieve a list of user members and returns a UserMembersQueryBuilder 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 UserMembersQueryBuilder functions onto the query. UserMembersQueryBuilder functions enable you to sort, filter, and control the results queryUserMembers() returns.

queryUserMembers() runs with these UserMembersQueryBuilder defaults, which you can override:

  • limit(50)
PROPERTYSUPPORTED FILTERS & SORTING
memberIdeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
userIdeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
siteMembersInstanceIdeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
metaSiteIdeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
_createdDateeq(),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
SCOPE.DC-MEMBERS.READ-USER-MEMBERS
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Errors

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

Did this help?