Pending Requests

GET

api

group

requests

:instance

Pending Requests

curl --request GET \
  --url https://api.example.com/api/group/requests/:instance \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://api.example.com/api/group/requests/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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"

await fetch(`https://ryzeapi.cloud/api/group/requests/${process.env.Instance_Name}?identifier=120363406289005073@g.us`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/group/requests/{os.environ['Instance_Name']}?identifier=120363406289005073@g.us",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/group/requests/"+os.Getenv("Instance_Name")+"?identifier=120363406289005073@g.us", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

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

string

required

Instance name.

Headers

string

required

TokenAccount or TokenInstance.

Query

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

HTTP	Message
400	`Identifier is required`
403	`Not authorized to view group requests (must be admin)`
404	`Group 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)" }
}

Approve / reject

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

Update group

Enable or disable requireAdminApproval.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Pending Requests

Description

Examples

List requests

Success response

Path parameters

Headers

Query

Notes

Errors

Next

Approve / reject

Update group

​Description

​Examples

​List requests

​Success response

​Path parameters

​Headers

​Query

​Notes

​Errors

​Next

Approve / reject

Update group

Description

Examples

List requests

Success response

Path parameters

Headers

Query

Notes

Errors

Next