POST

Query Group Requests


Retrieves a list of groups requests across a site.

Supported fields for filtering:

  • status

Supported fields for sorting:

  • createdDate
Endpoint
POST
https://www.wixapis.com/_api/social-groups-proxy/group-requests/v2/group-requests/query

Body Params
queryQuery
Response Object
groupRequestsArray <GroupRequest>

Retrieved group requests.


metadataMetadata

Paging information.

Query Group Requests Example 1
Request
cURL
curl -X POST \ https://wixapis.com/social-groups/v2/group-requests/query \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: <AUTH>' -d '{ "ownershipFilter": "CURRENT_MEMBER", "query": { "filter": { "status": { "$eq": "PENDING" } }, "sort": [ { "fieldName": "createdDate", "order": "DESC" } ], "paging": { "offset": 0, "limit": 100 } } }'
Response
JSON
{ "groupRequests": [ { "id": "a277bc77-1812-4484-8888-dc8cd0c357f2", "group": { "id": "a277bc77-1812-4484-8888-dc8cd0c357f2", "slug": "group-3", "privacyLevel": "PUBLIC", "title": "Group 3", "description": "Welcome to the group! You can connect with other members, get updates and share videos.", "details": { "membersTitle": "Friends" }, "settings": { "membersPermittedToInvite": false, "membersPermittedToApprove": false, "memberWelcomePostEnabled": true, "groupDetailsChangedPostEnabled": true, "showMemberList": true }, "membersCount": 1, "createdBy": { "id": "34571ac2-2785-482b-924a-6cbede6d378f", "identityType": "MEMBER" }, "createdDate": "2020-12-21T09:29:39Z", "updatedDate": "2020-12-21T09:29:42Z", "recentActivityDate": "2020-12-21T09:29:39Z" }, "status": "PENDING", "requestDetails": {} } ], "metadata": { "count": 1, "offset": 0, "total": 1 } }
Errors

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

Did this help?