Get Communities
Supported & TestedReturn participating WhatsApp Communities for the connected instance.
POSThttps://api.waplix.io/api/v1/communities/list
Authentication
Authorization: Bearer YOUR_API_KEY Parameters Specification
| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_id | string | Required | Required Waplix instance id |
| limit | number | Optional | Optional maximum number of communities to return |
instance_id
stringReq Required Waplix instance id
limit
numberOpt Optional maximum number of communities to return
Usage Notes
Returns participating WhatsApp Communities for the connected instance. An empty items array is valid when no communities are listed for the session.
Request Payload Example
Request
curl -X POST "https://api.waplix.io/api/v1/api/v1/communities/list" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"instance_id": "demo_instance"
}'Success Response
Response · 200 OK
{
"success": true,
"data": {
"instance_id": "demo_instance",
"items": []
}
} Was this page helpful?