> ## Documentation Index
> Fetch the complete documentation index at: https://developer.omni.z-api.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar canal

> Consulte os dados de um canal pelo identificador

export const EnterpriseText = ({lang = 'pt'}) => ({
  pt: <>Este endpoint requer a role <strong>ENTERPRISE</strong> na sua conta.</>,
  en: <>This endpoint requires the <strong>ENTERPRISE</strong> role on your account.</>,
  es: <>Este endpoint requiere el rol <strong>ENTERPRISE</strong> en tu cuenta.</>
})[lang];

## Conceituação

Retorna um canal do workspace da sua Secret Key, com os mesmos campos da listagem e mais os webhooks cadastrados nele — id, URL e eventos de cada endpoint.

<Warning>
  <EnterpriseText lang="pt" />
</Warning>

<Note>
  Canal de outro workspace responde `404`, igual a canal inexistente. A resposta não distingue os dois casos de propósito.
</Note>

### Webhooks

Diferente da Z-API, onde cada instância tem uma URL fixa por tipo de callback, no Omni um canal pode ter vários endpoints, cada um inscrito nos eventos que você escolher. Para criar, editar ou remover, use as rotas de [webhooks do canal](/webhooks/channel-webhooks).

<Note>
  O `channelId` é obtido através do endpoint [Criar canal](/channels/create-channel) ou de [Listar canais](/channels/list-channels).
</Note>


## OpenAPI

````yaml pt/channels/openapi-get.json GET /v1/channels/{channelId}
openapi: 3.1.0
info:
  title: 'Omni Z-API - Parceiro: Consultar Canal'
  version: 1.0.0
servers:
  - url: https://api.omni.z-api.io
security:
  - bearerAuth: []
paths:
  /v1/channels/{channelId}:
    get:
      tags:
        - Parceiros
      summary: Consultar canal (Parceiro)
      description: >-
        Retorna os dados de um canal do workspace da chave, junto dos webhooks
        cadastrados nele. Requer role ENTERPRISE.
      operationId: partnerGetChannel
      parameters:
        - name: channelId
          in: path
          required: true
          description: Identificador do canal
          schema:
            type: string
            example: AA0C61D24A6549A3BF83239847DE1CC2
      responses:
        '200':
          description: Canal encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
        '400':
          description: Autorizacao invalida ou parametro fora do formato esperado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                authorization:
                  summary: Authorization
                  value:
                    error: Authorization invalid
        '404':
          description: Canal nao encontrado no workspace da chave
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Channel not found
        '422':
          description: Conta sem role ENTERPRISE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Channel listing requires ENTERPRISE role
components:
  schemas:
    Channel:
      type: object
      properties:
        id:
          type: string
          example: AA0C61D24A6549A3BF83239847DE1CC2
        name:
          type: string
          example: Suporte
        token:
          type: string
          nullable: true
          example: F1B29C3D4E5A6B7C8D9E0F1A2B3C4D5E
        tenant:
          type: string
          example: 01A090B7FB82798CB38AB259C0B65FBE
        type:
          type: string
          enum:
            - META_WHATSAPP
            - Z_API_WHATSAPP
            - META_INSTAGRAM
            - META_MESSENGER
            - BOT_TELEGRAM
          example: META_WHATSAPP
        created:
          type: string
          format: date-time
          example: '2026-03-11T14:02:00.000Z'
        due:
          type: integer
          format: int64
          nullable: true
          example: 1774915200000
        paymentStatus:
          type: string
          enum:
            - PAID
            - PENDING
            - BOLETO_PENDING
            - CANCELLATION_PROCESS
            - CANCELED
            - TRIAL
          example: PAID
        phoneConnected:
          type: boolean
          example: true
        whatsappConnected:
          type: boolean
          example: true
        phoneNumberConnected:
          type: string
          nullable: true
          example: '5585999999999'
        businessId:
          type: string
          nullable: true
          example: '102938475610293'
        whatsappCoexistence:
          type: boolean
          example: false
        webhooks:
          type: array
          items:
            $ref: '#/components/schemas/ChannelWebhook'
    Error:
      type: object
      properties:
        error:
          type: string
    ChannelWebhook:
      type: object
      properties:
        id:
          type: string
          example: 01A08132F180733B83D7B7BDFAF9E574
        url:
          type: string
          example: https://parceiro.example.com/hook
        events:
          type: array
          items:
            type: string
          example:
            - MESSAGE_RECEIVED
            - MESSAGE_DELIVERY
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Secret Key gerada no painel de Seguranca do Omni Z-API

````