Skip to main content
GET
Get channel (Partner)

Overview

Returns a channel from the workspace of your Secret Key, with the same fields as the listing plus the webhooks registered on it — id, URL and events of each endpoint.
A channel from another workspace returns 404, the same as a channel that does not exist. The response does not distinguish between the two cases on purpose.

Webhooks

Unlike Z-API, where each instance has a fixed URL per callback type, in Omni a channel can have several endpoints, each subscribed to the events you choose. To create, update or delete them, use the channel webhook routes.
The channelId comes from the Create channel endpoint or from List channels.

Authorizations

Authorization
string
header
required

Secret Key generated in the Omni Z-API Security panel

Path Parameters

channelId
string
required

Channel identifier

Example:

"AA0C61D24A6549A3BF83239847DE1CC2"

Response

Channel found

id
string
Example:

"AA0C61D24A6549A3BF83239847DE1CC2"

name
string
Example:

"Suporte"

token
string | null
Example:

"F1B29C3D4E5A6B7C8D9E0F1A2B3C4D5E"

tenant
string
Example:

"01A090B7FB82798CB38AB259C0B65FBE"

type
enum<string>
Available options:
META_WHATSAPP,
Z_API_WHATSAPP,
META_INSTAGRAM,
META_MESSENGER,
BOT_TELEGRAM
Example:

"META_WHATSAPP"

created
string<date-time>
Example:

"2026-03-11T14:02:00.000Z"

due
integer<int64> | null
Example:

1774915200000

paymentStatus
enum<string>
Available options:
PAID,
PENDING,
BOLETO_PENDING,
CANCELLATION_PROCESS,
CANCELED,
TRIAL
Example:

"PAID"

phoneConnected
boolean
Example:

true

whatsappConnected
boolean
Example:

true

phoneNumberConnected
string | null
Example:

"5585999999999"

businessId
string | null
Example:

"102938475610293"

whatsappCoexistence
boolean
Example:

false

webhooks
object[]