POST

Query User Members


Developer Preview

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

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. To access the information without member authentication, you need the MEMBERS.USER_MEMBER_READ_WITHOUT_USER_ID permission.

Authentication

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

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

Body Params
queryQuery

Query options. See API Query Language for more details.

Response Object
userMembersArray <UserMember>

Retrieved user members.


metadataMetadata

Metadata for the paginated results.

Query User Members
Request
cURL
Response
JSON
Errors

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

Did this help?