POST

Query Group Members


Retrieves a list of up to 100 group members, given the provided paging, sorting and filtering. Groups managers can retrieve group members of any group.

Supported fields for filtering:

  • role

Supported fields for sorting:

  • joinedOn
  • role
Endpoint
POST
https://www.wixapis.com/social-groups-proxy/members/v2/groups/{groupId}/members/query

Path Params
groupIdstringRequired

Group ID.

Body Params
queryQuery
Response Object
membersArray <GroupMember>

Group members.


metadataMetadata

Paging information.

Query Group Members Example 1
Request
cURL
curl -X POST \ https://wixapis.com/social-groups/v2/groups/8a258cf5-49f3-41dc-b320-65ec2598315b/members/query \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: <AUTH>' -d '{ "query": { "filter": { "role": { "$eq": "ADMIN" } }, "sort": [ { "fieldName": "joinedOn", "order": "DESC" } ], "paging": { "offset": 0, "limit": 100 } } }'
Response
JSON
{ "members": [ { "siteMemberId": "223c37e0-3474-43c5-8d47-e374b414ef68", "role": { "value": "ADMIN" }, "joinedDate": "2020-12-19T17:40:23Z" }, { "siteMemberId": "88e40cba-392b-4333-8717-9375d57f4de7", "role": { "value": "ADMIN" }, "joinedDate": "2020-09-17T09:17:56Z" } ], "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?