Skip to main content
GET
/
groups
/
{id}
/
requests
Get pending join requests
curl --request GET \
  --url https://api.wsapi.chat/groups/{id}/requests \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>'
[
  {
    "user": {
      "id": "1234567890@s.whatsapp.net",
      "lid": "222424242@lid",
      "phone": "1234567890",
      "device": 2
    },
    "requestedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Path Parameters

​
id
string
required

Group JID

Response

List of pending join requests

​
user
object

Represents a WhatsApp user with all known identifiers. The id field is always present: it prefers a phone-based JID, falling back to LID.

​
requestedAt
string<date-time>