POST

Query Join Group Requests

Retrieves a list of up to 100 join group requests, given the provided paging and filtering. Group managers always have access to this functionality (site members can access their own join group requests in the site).

Supported fields for filtering:

  • status

No supported fields for sorting

Endpoint
POST
https://www.wixapis.com/social-groups-proxy/join/v2/groups/{groupId}/join-requests/query
Path Params
groupIdstringRequired

Group ID.

Body Params
queryQuery
Response Object
joinGroupRequestsArray <JoinGroupRequest>

Join group requests.

metadataMetadata
Query Join Group Requests Example 1
Request
cURL
curl -X POST \
    https://wixapis.com/social-groups/v2/groups/a4caf853-c0d7-498e-8eaa-3db36522dcbf/join-requests/query \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: <AUTH>'
    -d '{
        "ownershipFilter": "CURRENT_MEMBER",
        "query": {
            "filter": {
                "status": {
                    "$eq": "APPROVED"
                }
            },
            "paging": {
                "offset": 0,
                "limit": 100
            }
        }
    }'
Response
JSON
{
  "joinGroupRequests": [
    {
      "siteMemberId": "e6674661-f294-4f1f-9f22-bc11fa8164e7",
      "status": "APPROVED"
    }
  ],
  "metadata": {
    "count": 1,
    "offset": 0
  }
}
Errors

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

Did this help?