Sign in
👥 Groups

Get pending requests to join the group

get/api/{session}/groups/{id}/participants/join-requests

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/{session}/groups/{id}/participants/join-requests
  • Auth: API key in header X-Api-Key

Path parameters

sessionstring required

Session name

idstring required
Example:123123123@g.us

Group ID

Response

requesterIdstring required

ID of the user requesting to join the group

requesterPnstring nullable

Phone number ID of the requester, if known

addedByIdstring nullable required

ID of the user who created the request

parentGroupIdstring nullable required

ID of the parent community group, if present

requestMethodstring nullable required

How the request was created, for example non_admin_add, invite_link, or linked_group_join

timestampnumber required

Unix timestamp when the request was created

Example response

[
  {
    "requesterId": "123456789@c.us",
    "requesterPn": "123456789@c.us",
    "addedById": "123456789@c.us",
    "parentGroupId": "123456789@g.us",
    "requestMethod": "invite_link",
    "timestamp": 1666943582
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.