Skip to main content
GET

Authorizations

X-API-Key
string
header
required

Path Parameters

businessPhoneNumber
string
required

The WhatsApp business phone number in E.164 format.

Example:

"+16315551111"

groupId
string
required

WhatsApp group ID.

Example:

"120363345678901234@g.us"

Query Parameters

limit
integer<int32>
default:25

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

Required range: 1 <= x <= 1024
before
string

A cursor to fetch the previous page.

Example:

"eyJvIjoiYmVmb3JlIn0"

after
string

A cursor to fetch the next page.

Example:

"eyJvIjoiYWZ0ZXIifQ"

Response

Successfully retrieved group join requests.

Cursor-paginated WhatsApp group join request response.

data
object[]
paging
object

Cursor pagination information.