Skip to main content
Retrieve detailed information about a WhatsApp group.
This endpoint returns comprehensive group metadata including participants, settings, and creation details.

​
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 WhatsApp group ID to retrieve information forExample: [email protected]

​
Response

​
status
integer
HTTP status code (e.g., 200)
​
code
string
Response code (e.g., SUCCESS)
​
message
string
Response message describing the resultExample: Success get group info
​
results
object
Group information object containing:
  • Group metadata (JID, name, topic, owner)
  • Creation and modification timestamps
  • Participant list with roles
  • Group settings (announce, locked, ephemeral)
  • Version identifiers
Note: The structure may vary based on group configuration
curl -X GET \
  'https://your-api-domain.com/group/[email protected]' \
  -H 'X-Device-Id: my-device' \
  -u 'username:password'

{
  "status": 200,
  "code": "SUCCESS",
  "message": "Success get group info",
  "results": {
    "JID": "[email protected]",
    "OwnerJID": "[email protected]",
    "Name": "Example Group",
    "Topic": "Welcome to our group!",
    "GroupCreated": "2024-01-10T08:00:00Z",
    "IsAnnounce": false,
    "IsLocked": false,
    "IsEphemeral": false,
    "Participants": [
      {
        "JID": "[email protected]",
        "IsAdmin": true,
        "IsSuperAdmin": true
      }
    ]
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us