Skip to main content
GET
/
api
/
{session}
/
groups
/
{id}
/
participants
Get participants
curl --request GET \
  --url https://{host}/api/{session}/groups/{id}/participants \
  --header 'apikey: <api-key>'
{
  "participants": [
    {
      "id": "5511999999999@s.whatsapp.net",
      "isAdmin": true,
      "isSuperAdmin": true
    },
    {
      "id": "5511888888888@s.whatsapp.net",
      "isAdmin": false,
      "isSuperAdmin": false
    }
  ]
}

​
Description

This endpoint returns a list of all participants of a specific group.

​
URL Parameters

​
session
string
required
WhatsApp unique session ID
​
id
string
required
ID of the group in format 120363XXXXX@g.us

​
Response

​
participants
array
Array with the participants of the group
{
  "participants": [
    {
      "id": "5511999999999@s.whatsapp.net",
      "isAdmin": true,
      "isSuperAdmin": true
    },
    {
      "id": "5511888888888@s.whatsapp.net",
      "isAdmin": false,
      "isSuperAdmin": false
    }
  ]
}

​
Status Codes

  • 200 - Participants returned successfully
  • 400 - Invalid parameters
  • 401 - Unauthorized
  • 404 - Group not found

​
Usage Example

curl -X GET https://api.wappfy.com.br/api/my-session/groups/120363XXXXX@g.us/participants

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

​
id
string
required

ID do Grupo

⌘I