Get All Labels
Supported & TestedReturns all labels currently available on the connected WhatsApp account.
POSThttps://api.waplix.io/api/v1/labels/list
Authentication
Authorization: Bearer YOUR_API_KEY Parameters Specification
| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_id | string | Required | Required Waplix instance id |
| include_counts | string | Optional | Optional boolean to include label counts when available |
instance_id
stringReq Required Waplix instance id
include_counts
stringOpt Optional boolean to include label counts when available
Usage Notes
Verified on production instance 29854.
Request Payload Example
Request
curl -X POST "https://api.waplix.io/api/v1/api/v1/labels/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": [
{
"name": "John Doe",
"color": 0,
"predefined_id": null
},
{
"name": "Demo User",
"color": 0,
"predefined_id": null
},
{
"name": "Jane Doe",
"color": 0,
"predefined_id": null
}
]
}
} Was this page helpful?