POST

Query User Members


Retrieves a list of user members, given the provided paging, filtering, and sorting.

Query User Members runs with these defaults, which you can override:

  • createdDate is sorted in ASC order
  • paging.limit is 100
  • paging.offset is 0

For field support for filters and sorting, see Supported Filters and Sorting. To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

Note: This method requires visitor or member authentication.

FieldSupported FiltersSort
memberId$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ASC, DESC
siteMembersInstanceId$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ASC, DESC
userId$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ASC, DESC
metaSiteId$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ASC, DESC
status$eq, $ne, $exists, $in, $anySort: ASC, DESC
createdDate$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gteSort: ASC, DESC
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
SCOPE.DC-MEMBERS.MANAGE-USER-MEMBERS
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/members/v1/user-members/query

Errors

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

Did this help?