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

# Listar canales

> Lista los canales de tu workspace mediante la API

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

## Conceptos

Devuelve los canales del workspace de tu Secret Key, del más reciente al más antiguo. Los canales eliminados no aparecen, y los de otros workspaces tampoco: el alcance es siempre la cuenta dueña de la clave.

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

### Paginación

| Parámetro | Valor por defecto | Límite |
| - | - | - |
| `page` | `0` | — |
| `pageSize` | `20` | `100` |

La respuesta trae `total` (canales que cumplen el filtro), `totalPage`, `pageSize` y `page`, con los canales en `content`.

### Filtros

| Parámetro | Efecto |
| - | - |
| `query` | Parte del nombre del canal, sin distinguir mayúsculas de minúsculas, o el inicio del identificador |
| `type` | Tecnología del canal: `META_WHATSAPP`, `Z_API_WHATSAPP`, `META_INSTAGRAM`, `META_MESSENGER`, `BOT_TELEGRAM` |
| `middleware` | Sinónimo de `type`. Si se envían ambos, prevalece `type` |

<Note>
  En Z-API, `middleware` indica si la instancia corre en `web` o `mobile`. En Omni no existe esa distinción: el campo guarda la tecnología del canal, el mismo valor aceptado en [Crear canal](/es/channels/create-channel). El parámetro `middleware` existe para quien migró desde Z-API y mantiene el nombre antiguo en su código.
</Note>

### Webhooks del canal

Cada canal trae `webhooksCount`, la cantidad de endpoints de webhook registrados en él. Para ver las URLs y los eventos de cada uno, usa [Consultar canal](/es/channels/get-channel) o [Listar webhooks](/es/webhooks/list-webhooks).


## OpenAPI

````yaml es/channels/openapi-list.json GET /v1/channels
openapi: 3.1.0
info:
  title: 'Omni Z-API - Socio: Listar Canales'
  version: 1.0.0
servers:
  - url: https://api.omni.z-api.io
security:
  - bearerAuth: []
paths:
  /v1/channels:
    get:
      tags:
        - Socios
      summary: Listar canales (Socio)
      description: >-
        Lista los canales del workspace de la clave, del mas reciente al mas
        antiguo, con paginacion y filtros opcionales. Requiere el rol
        ENTERPRISE.
      operationId: partnerListChannels
      parameters:
        - name: page
          in: query
          required: false
          description: Pagina deseada, empezando en 0
          schema:
            type: integer
            minimum: 0
            default: 0
        - name: pageSize
          in: query
          required: false
          description: Cantidad de canales por pagina (1 a 100)
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: query
          in: query
          required: false
          description: >-
            Filtra por parte del nombre del canal o por el inicio del
            identificador
          schema:
            type: string
            example: suporte
        - name: type
          in: query
          required: false
          description: Filtra por la tecnologia del canal
          schema:
            type: string
            enum:
              - META_WHATSAPP
              - Z_API_WHATSAPP
              - META_INSTAGRAM
              - META_MESSENGER
              - BOT_TELEGRAM
        - name: middleware
          in: query
          required: false
          description: >-
            Sinonimo de `type`, para quien viene de Z-API. Si se envian ambos,
            prevalece `type`
          schema:
            type: string
            enum:
              - META_WHATSAPP
              - Z_API_WHATSAPP
              - META_INSTAGRAM
              - META_MESSENGER
              - BOT_TELEGRAM
      responses:
        '200':
          description: Pagina de canales del workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelPage'
        '400':
          description: Autorizacion invalida o parametro fuera del formato esperado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                authorization:
                  summary: Authorization
                  value:
                    error: Authorization invalid
                pageSize:
                  summary: pageSize
                  value:
                    error: pageSize must be between 1 and 100
                type:
                  summary: type
                  value:
                    error: >-
                      type must be one of [META_WHATSAPP, Z_API_WHATSAPP,
                      META_INSTAGRAM, META_MESSENGER, BOT_TELEGRAM]
        '422':
          description: Cuenta sin el rol ENTERPRISE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Channel listing requires ENTERPRISE role
components:
  schemas:
    ChannelPage:
      type: object
      properties:
        total:
          type: integer
          format: int64
          example: 37
        totalPage:
          type: integer
          example: 2
        pageSize:
          type: integer
          example: 20
        page:
          type: integer
          example: 0
        content:
          type: array
          items:
            $ref: '#/components/schemas/Channel'
    Error:
      type: object
      properties:
        error:
          type: string
    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
        webhooksCount:
          type: integer
          format: int64
          description: Cantidad de webhooks registrados en el canal
          example: 2
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Secret Key generada en el panel de Seguridad de Omni Z-API

````