Listar canais (Parceiro)
curl --request GET \
--url https://api.omni.z-api.io/v1/channels \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.omni.z-api.io/v1/channels"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.omni.z-api.io/v1/channels', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.omni.z-api.io/v1/channels",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.omni.z-api.io/v1/channels"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.omni.z-api.io/v1/channels")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/v1/channels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"total": 37,
"totalPage": 2,
"pageSize": 20,
"page": 0,
"content": [
{
"id": "AA0C61D24A6549A3BF83239847DE1CC2",
"name": "Suporte",
"token": "F1B29C3D4E5A6B7C8D9E0F1A2B3C4D5E",
"tenant": "01A090B7FB82798CB38AB259C0B65FBE",
"type": "META_WHATSAPP",
"created": "2026-03-11T14:02:00.000Z",
"due": 1774915200000,
"paymentStatus": "PAID",
"phoneConnected": true,
"whatsappConnected": true,
"phoneNumberConnected": "5585999999999",
"businessId": "102938475610293",
"whatsappCoexistence": false,
"webhooksCount": 2
}
]
}Canais
Listar canais
Liste os canais do seu workspace via API
GET
/
v1
/
channels
Listar canais (Parceiro)
curl --request GET \
--url https://api.omni.z-api.io/v1/channels \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.omni.z-api.io/v1/channels"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.omni.z-api.io/v1/channels', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.omni.z-api.io/v1/channels",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.omni.z-api.io/v1/channels"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.omni.z-api.io/v1/channels")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/v1/channels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"total": 37,
"totalPage": 2,
"pageSize": 20,
"page": 0,
"content": [
{
"id": "AA0C61D24A6549A3BF83239847DE1CC2",
"name": "Suporte",
"token": "F1B29C3D4E5A6B7C8D9E0F1A2B3C4D5E",
"tenant": "01A090B7FB82798CB38AB259C0B65FBE",
"type": "META_WHATSAPP",
"created": "2026-03-11T14:02:00.000Z",
"due": 1774915200000,
"paymentStatus": "PAID",
"phoneConnected": true,
"whatsappConnected": true,
"phoneNumberConnected": "5585999999999",
"businessId": "102938475610293",
"whatsappCoexistence": false,
"webhooksCount": 2
}
]
}Conceituação
Retorna os canais do workspace da sua Secret Key, do mais recente para o mais antigo. Canais excluídos não aparecem, e canais de outros workspaces também não — o escopo é sempre a conta dona da chave.Paginação
| Parâmetro | Padrão | Limite |
|---|---|---|
page | 0 | — |
pageSize | 20 | 100 |
total (canais que atendem ao filtro), totalPage, pageSize e page, e os canais em content.
Filtros
| Parâmetro | Efeito |
|---|---|
query | Trecho do nome do canal, sem diferenciar maiúsculas de minúsculas, ou o início do identificador |
type | Tecnologia do canal: META_WHATSAPP, Z_API_WHATSAPP, META_INSTAGRAM, META_MESSENGER, BOT_TELEGRAM |
middleware | Sinônimo de type. Se os dois forem enviados, type prevalece |
Na Z-API,
middleware diz se a instância roda em web ou mobile. No Omni não existe essa distinção: o campo guarda a tecnologia do canal, o mesmo valor aceito em Criar canal. O parâmetro middleware existe para quem migrou da Z-API e mantém o nome antigo no código.Webhooks do canal
Cada canal trazwebhooksCount, a quantidade de endpoints de webhook cadastrados nele. Para ver as URLs e os eventos de cada um, use Consultar canal ou Listar webhooks.Autorizações
Secret Key gerada no painel de Seguranca do Omni Z-API
Parâmetros de consulta
Pagina desejada, comecando em 0
Intervalo obrigatório:
x >= 0Quantidade de canais por pagina (1 a 100)
Intervalo obrigatório:
1 <= x <= 100Filtra por trecho do nome do canal ou pelo inicio do identificador
Exemplo:
"suporte"
Filtra pela tecnologia do canal
Opções disponíveis:
META_WHATSAPP, Z_API_WHATSAPP, META_INSTAGRAM, META_MESSENGER, BOT_TELEGRAM Sinonimo de type, para quem vem da Z-API. Se os dois forem enviados, type prevalece
Opções disponíveis:
META_WHATSAPP, Z_API_WHATSAPP, META_INSTAGRAM, META_MESSENGER, BOT_TELEGRAM