Get Community By ID

Supported & Tested

Return metadata for a specific WhatsApp Community by its community id.

POSThttps://api.waplix.io/api/v1/communities/info
Authentication
Authorization: Bearer YOUR_API_KEY
Parameters Specification
instance_id
stringReq

Required Waplix instance id

community_id
stringReq

Required valid WhatsApp community id ending with @g.us

Usage Notes
Returns metadata for a specific WhatsApp Community.
Request Payload Example
Request
curl -X POST "https://api.waplix.io/api/v1/api/v1/communities/info" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "instance_id": "demo_instance",
  "community_id": "120363000000000001@g.us"
}'
Success Response
Response · 200 OK
{
  "success": true,
  "data": {
    "instance_id": "demo_instance",
    "community_id": "120363000000000001@g.us",
    "subject": "Demo Community",
    "description": "Community created for API documentation.",
    "participants_count": 1,
    "subgroups_count": 1,
    "is_community": true
  }
}
Was this page helpful?