Skip to main content
GET
Retrieve a channel

Authorizations

Authorization
string
header
required

A workspace API token (sk_live_...) or an OAuth access token (oat_live_...). Create workspace tokens in Settings > API. Send either as Authorization: Bearer <token>.

Path Parameters

channel_id
string
required

Unique identifier for a channel.

Pattern: ^chn_[0-9a-f]{32}$
Example:

"chn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

Response

Successful Response

A connection your workspace talks to contacts through.

created_at
string<date-time>
required
id
string
required

Unique identifier for a channel.

Pattern: ^chn_[0-9a-f]{32}$
Example:

"chn_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

name
string
required

The name shown in Sailer, e.g. Sales WhatsApp.

status
enum<string>
required

Whether a channel can send and receive right now.

active works. disconnected lost its connection (for example the phone went offline) and needs reconnecting. pending is still being set up. restricted was blocked or banned by the platform.

Available options:
active,
disconnected,
pending,
restricted
updated_at
string<date-time>
required
object
string
default:channel
Allowed value: "channel"
phone_number
string | null

The channel's number in E.164 format, for WhatsApp channels.

platform
enum<string> | null

The messaging platform a channel runs on.

whatsapp_api is the official WhatsApp Business Platform, the only one that supports message templates. whatsapp is a number connected through the WhatsApp app. botconversa is a channel fed by an external chatbot integration.

Available options:
whatsapp_api,
whatsapp,
instagram,
slack,
web_widget,
botconversa