Skip to main content
GET
List channels (Partner)

Overview

Returns the channels in the workspace of your Secret Key, newest first. Deleted channels are not listed, and neither are channels from other workspaces — the scope is always the account that owns the key.

Pagination

The response carries total (channels matching the filter), totalPage, pageSize and page, with the channels in content.

Filters

In Z-API, middleware tells whether the instance runs on web or mobile. Omni has no such distinction: the field holds the channel technology, the same value accepted in Create channel. The middleware parameter exists for those who migrated from Z-API and kept the old name in their code.

Channel webhooks

Each channel carries webhooksCount, the number of webhook endpoints registered on it. To see the URLs and events of each one, use Get channel or List webhooks.

Authorizations

Authorization
string
header
required

Secret Key generated in the Omni Z-API Security panel

Query Parameters

page
integer
default:0

Page to retrieve, starting at 0

Required range: x >= 0
pageSize
integer
default:20

Channels per page (1 to 100)

Required range: 1 <= x <= 100
query
string

Filters by part of the channel name or by the beginning of the identifier

Example:

"suporte"

type
enum<string>

Filters by channel technology

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

Alias of type, for those coming from Z-API. If both are sent, type wins

Available options:
META_WHATSAPP,
Z_API_WHATSAPP,
META_INSTAGRAM,
META_MESSENGER,
BOT_TELEGRAM

Response

Page of channels in the workspace

total
integer<int64>
Example:

37

totalPage
integer
Example:

2

pageSize
integer
Example:

20

page
integer
Example:

0

content
object[]