Get Channel Info
Get detailed information about a specific channel.
Authentication Required
Login to swap the placeholders with your real Instance ID and Access Token.
Log InNo query parameters required
This endpoint doesn't expect data in the URL.
Best practices
Cache channel metadata to reduce API usage.
Monitor subscriber growth trends over time.
Deep Dive: Channel Metadata
The /v2/channels/{id} endpoint allows you to retrieve the full profile of any public channel, provided you have its ID (JID). This is useful for refreshing metadata like subscriber counts or profile pictures.
🏗️ The Data Payload
Beyond the basic name, this endpoint returns critical fields for integration:
1. invite_link
- Usage: The
https://whatsapp.com/channel/...URL. - Strategy: If you are building a directory, display this link to let users open the channel directly in their native WhatsApp app.
2. subscribers (Count)
- Accuracy: This is an approximate count (e.g., 1.2M), not an exact integer down to the last digit for large channels.
- Analytics: Track this over time to measure growth or campaign effectiveness.
3. verified
- Green Tick: Indicates if the channel belongs to an authentic, notable brand.
- UI Tip: Always display a verification badge next to the name if this is
true. It builds trust with your users.
🔄 Refresh Strategy
When to call this?
Channel metadata is static for long periods.
- Do: Call this when a user clicks on a channel to view its details.
- Don't: Call this in a loop for every channel in your list. Use
/v2/channelsfor bulk retrieval.
Handling 404s
If this endpoint returns a 404 Session not found or similar error regarding the channel ID:
- Meaning: The channel may have been deleted by the owner or banned by WhatsApp.
- Action: Automatically remove this channel from your local database or mark it as "Inactive".
🔒 Privacy Note
Fetching channel info is a public action. The channel owner does not know you requested this data. It is similar to loading a public web page.
Request Parameters
Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.
URL Parameters
Passed in the URL query stringstring | Your unique WhatsApp Instance ID Example: | ||
string | Your API Access Token Example: | ||
string | The unique ID of the channel Example: |
Request Samples
Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.
Expected Responses
Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.
Example
{
"id": "1234567890@newsletter",
"name": "Channel Name",
"description": "Channel Description",
"subscribers": 1500
}Command Palette
Search for a command to run...