POST

Query Memberships


Retrieves a list of up to 100 members and their membership status, given the provided paging and filtering. Groups managers can see all memberships for any group.

Supported fields for filtering:

  • role
  • status

No supported fields for sorting.

Endpoint
POST
https://www.wixapis.com/social-groups-proxy/members/v2/members/{memberId}/memberships/query

Path Params
memberIdstringRequired

Member ID. See the Members API for details.

Body Params
queryQuery
Response Object
membershipsArray <Membership>

Site member's memberships.


metadataMetadata

Paging information.

Query Memberships Example 1
Request
cURL
curl -X POST \ https://wixapis.com/social-groups/v2/members/223c37e0-3474-43c5-8d47-e374b414ef68/memberships/query \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: <AUTH>' -d '{ "query": { "filter": { "status": { "$eq": "JOINED" } }, "paging": { "offset": 0, "limit": 100 } } }'
Response
JSON
{ "memberships": [ { "groupId": "8a258cf5-49f3-41dc-b320-65ec2598315b", "status": "JOINED", "role": { "value": "ADMIN" } }, { "groupId": "3e3b08b6-9fdf-48b9-b2c3-762d6953fa0b", "status": "JOINED", "role": { "value": "MEMBER" } } ], "metadata": { "count": 2, "offset": 0, "total": 2 } }
Errors

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

Did this help?