---
title: "GET /v2/workspace/{workspaceId}/channels"
method: GET
path: "/v2/workspace/{workspaceId}/channels"
---

# GET /v2/workspace/{workspaceId}/channels

`GET /v2/workspace/{workspaceId}/channels`

Este é o endpoint mais atualizado para listagem de canais, onde os canais são gerenciados separadamente dos agentes (desmembrados), refletindo a nova estrutura do sistema.

## Path parameters

- `workspaceId` string, required

## Query parameters

- `page` integer
- `pageSize` integer
- `query` string
- `agentId` string

## Response `200`

Lista de canais retornada com sucesso

- object
  - `data` object[] — Lista de canais
    - `name` string — Nome do canal
    - `id` string — ID do canal
    - `type` 'Z_API' | 'WHATSAPP' | 'INSTAGRAM' | 'CLOUD_API' | 'TELEGRAM' | 'WIDGET' | 'MESSENGER' | 'MERCADO_LIVRE' | 'TWILIO_SMS' — Tipo do canal
    - `agentId` string, nullable — ID do agente vinculado (quando houver)
    - `agentPicture` string, nullable — URL da foto do agente vinculado (quando houver)
    - `agentName` string, nullable — Nome do agente vinculado (quando houver)
    - `facebookPageId` string, nullable — ID da página do Facebook (quando aplicável)
    - `connected` boolean — Indica se o canal está conectado
    - `username` string, nullable — Identificador do canal (ex.: telefone/usuário), quando aplicável
  - `count` integer — Quantidade total de canais retornados

## Other responses

- `403` — Erro de token
- `500` — Error

---

[API](https://skmtc.net/gptmaker/apis/openapi-gpt-maker.md) · [All operations](https://skmtc.net/gptmaker/apis/openapi-gpt-maker/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gptmaker/openapi-gpt-maker/versions/bda09b3eba6e/schema)