Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Groups

List group join requests

Returns a cursor-paginated list of pending join requests for a WhatsApp group.

get/whatsapp/{businessPhoneNumber}/groups/{groupId}/joinRequests

Path parameters

businessPhoneNumberstring required
Example:+16315551111

The WhatsApp business phone number in E.164 format.

groupIdstring required
Example:120363345678901234@g.us

WhatsApp group ID.

Query parameters

limitinteger

A limit on the number of results to be returned, between 1 and 1024. Defaults to 25.

beforestring
Example:eyJvIjoiYmVmb3JlIn0

A cursor to fetch the previous page.

afterstring
Example:eyJvIjoiYWZ0ZXIifQ

A cursor to fetch the next page.

Response

Successfully retrieved group join requests.

Example response

{
  "data": [
    {
      "joinRequestId": "join-request-id",
      "waId": "16315551111",
      "userId": "US.1234",
      "parentUserId": "US.parent123",
      "username": "John",
      "creationTimestamp": 1739321024
    }
  ],
  "paging": {
    "before": "eyJvIjoiYmVmb3JlIn0",
    "after": "eyJvIjoiYWZ0ZXIifQ"
  }
}