Skip to main content
Retrieve a list of all participants in a WhatsApp group, including their roles and display information.
This endpoint returns detailed information about each participant, including their admin status and display names.

Request

X-Device-Id
string
Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default.
group_id
string
required
The group ID to fetch participants forExample: [email protected]

Response

code
string
Response code (e.g., SUCCESS)
message
string
Response message describing the resultExample: Success getting group participants
results
object
group_id
string
The group identifier
name
string
The group name
participants
array
Array of participant objects
curl -X GET \
  'https://your-api-domain.com/group/[email protected]' \
  -H 'X-Device-Id: my-device' \
  -u 'username:password'
{
  "code": "SUCCESS",
  "message": "Success getting group participants",
  "results": {
    "group_id": "[email protected]",
    "name": "My Awesome Group",
    "participants": [
      {
        "jid": "[email protected]",
        "phone_number": "[email protected]",
        "lid": "12345@lid",
        "display_name": "Anonymous Member",
        "is_admin": true,
        "is_super_admin": false
      }
    ]
  }
}

Build docs developers (and LLMs) love