Search Channels
Supported & TestedSearch WhatsApp Channels by a text query.
POSThttps://api.waplix.io/api/v1/channels/search
Authentication
Authorization: Bearer YOUR_API_KEY Parameters Specification
| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_id | string | Required | Required Waplix instance id |
| query | string | Required | Required text query |
| limit | number | Optional | Optional integer limit (default 10, max 50) |
| cursor | string | Optional | Optional pagination cursor from a previous search response |
instance_id
stringReq Required Waplix instance id
query
stringReq Required text query
limit
numberOpt Optional integer limit (default 10, max 50)
cursor
stringOpt Optional pagination cursor from a previous search response
Usage Notes
Search public WhatsApp Channels by text query. Use cursor for pagination when more results are available.
Request Payload Example
Request
curl -X POST "https://api.waplix.io/api/v1/api/v1/channels/search" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"instance_id": "demo_instance",
"query": "news",
"limit": 10
}'Success Response
Response · 200 OK
{
"success": true,
"data": {
"instance_id": "demo_instance",
"channels": [
{
"channel_id": "120363000000000000@newsletter",
"jid": "120363000000000000@newsletter",
"name": "Demo News Channel",
"description": "Latest news and updates.",
"subscribers_count": 125000,
"verified": true,
"picture_url": "https://example.com/channel-avatar.jpg"
}
],
"count": 1,
"cursor": "CURSOR_DEMO_NEXT",
"query": "news"
}
} Was this page helpful?