> ## 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.

# Get channel

> Get the data of a single channel by its identifier

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];

## 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.

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

<Note>
  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.
</Note>

### 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](/en/webhooks/channel-webhooks) routes.

<Note>
  The `channelId` comes from the [Create channel](/en/channels/create-channel) endpoint or from [List channels](/en/channels/list-channels).
</Note>


## OpenAPI

````yaml en/channels/openapi-get.json GET /v1/channels/{channelId}
openapi: 3.1.0
info:
  title: 'Omni Z-API - Partner: Get Channel'
  version: 1.0.0
servers:
  - url: https://api.omni.z-api.io
security:
  - bearerAuth: []
paths:
  /v1/channels/{channelId}:
    get:
      tags:
        - Partners
      summary: Get channel (Partner)
      description: >-
        Returns the data of a channel in the key's workspace, along with the
        webhooks registered on it. Requires the ENTERPRISE role.
      operationId: partnerGetChannel
      parameters:
        - name: channelId
          in: path
          required: true
          description: Channel identifier
          schema:
            type: string
            example: AA0C61D24A6549A3BF83239847DE1CC2
      responses:
        '200':
          description: Channel found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
        '400':
          description: Invalid authorization or parameter in an unexpected format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                authorization:
                  summary: Authorization
                  value:
                    error: Authorization invalid
        '404':
          description: Channel not found in the key's workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Channel not found
        '422':
          description: Account without the ENTERPRISE role
          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 generated in the Omni Z-API Security panel

````