Skip to main content
POST
Search channels

Overview

This method returns a list of channel data, according to the search performed through filters passed in the request body.

Attributes

string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.

Body

number
required
Record limit
object
required
Search filters
string
View type (RECOMMENDED, TRENDING, POPULAR or NEW)
string
Search text

Request Body


Response

200

Returns an array of channel objects.
string
Channel ID
number
Channel creation timestamp
string
Channel state (ACTIVE or NON_EXISTING)
string
Channel name
string
Channel description
string
Number of channel subscribers
Channel invite link
string
Verification status (VERIFIED or UNVERIFIED)
string
Channel image URL
string
Channel preview image URL
object
Channel view information
The channel ID must always contain the @newsletter suffix, as this is the standard used by WhatsApp.

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.