Skip to main content
GET
Returns the current status of a specific channel on an instance — whether it’s enabled in the config and whether it’s actually connected and running.

Authentication

Requires an org-level API key or a scoped token with the channels permission.

Path Parameters

string
required
The ID of the instance.
string
required
The channel identifier (e.g. discord, whatsapp).

Response

string
The channel identifier.
boolean
Whether the channel is enabled in the instance configuration.
boolean
Whether the channel is actively connected and running.
object
Additional status details, if available. The shape of this object varies by channel.