Skip to main content
GET
/
api
/
group
/
requests
/
:instance
Pending Requests
curl --request GET \
  --url https://api.example.com/api/group/requests/:instance \
  --header 'token: <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount or TokenInstance • Rate-limit: Global (100/min) • Idempotent: yes

​
Description

Lists pending join requests in a group that has requireAdminApproval=true. Only admins of the group can view this queue. To accept or reject, use POST /participants with action=approve or action=reject.

​
Examples

​
List requests

Returns the pending request queue for the group 120363406289005073@g.us. Each entry carries the LID and (when available) the phone number of who asked to join. 
curl -X GET "https://ryzeapi.cloud/api/group/requests/$Instance_Name?identifier=120363406289005073@g.us" \
  -H "token: $Token_Instance"

​
Success response

Returns the queue of pending requests under requests[], with meta.total reporting its size. Each entry carries the jid in LID format (@lid, to preserve the requester’s privacy) and, when available, the corresponding phoneNumber. Use these identifiers in /participants with action=approve or action=reject to resolve each request.
200 OK
{
  "success": true,
  "message": "2 pending requests found",
  "groupJid": "120363406289005073@g.us",
  "requests": [
    {
      "jid": "199789077627112@lid",
      "phoneNumber": "5511999999999@s.whatsapp.net",
      "requestedAt": "2026-04-20T14:00:00Z"
    }
  ],
  "meta": { "total": 2 }
}

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.

​
Query

​
identifier
string
required
Group JID, invite code, or link.

​
Notes

  • The returned jid comes in LID format (@lid) to preserve the requester’s privacy, in some cases phoneNumber may come as null.
  • To approve or reject in bulk, forward these JIDs (or PNs) to /participants.

​
Errors

HTTPMessage
400Identifier is required
403Not authorized to view group requests (must be admin)
404Group not found or you are not a member of this group
Envelope: 
{
  "success": false,
  "error": { "message": "Not authorized to view group requests (must be admin)" }
}

​
Next

Approve / reject

Use action=approve or action=reject on /api/group/participants.

Update group

Enable or disable requireAdminApproval.