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

# Listar canais do workspace

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



## OpenAPI

````yaml GET /v2/workspace/{workspaceId}/channels
openapi: 3.0.1
info:
  title: OpenAPI GPT Maker
  description: Documentação completa da API do GPT Maker
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.gptmaker.ai
security:
  - bearerAuth: []
paths:
  /v2/workspace/{workspaceId}/channels:
    get:
      description: >-
        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.
      parameters:
        - name: workspaceId
          in: path
          description: ID do workspace
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: 'Número da página (padrão: 1)'
          required: false
          schema:
            type: integer
            default: 1
            minimum: 1
            example: 1
        - name: pageSize
          in: query
          description: 'Quantidade de itens por página (padrão: 25)'
          required: false
          schema:
            type: integer
            default: 25
            minimum: 1
            example: 25
        - name: query
          in: query
          description: 'Texto para busca/filtragem (padrão: vazio)'
          required: false
          schema:
            type: string
            default: ''
            example: ''
        - name: agentId
          in: query
          description: >-
            Filtra pelos canais vinculados a um agente específico (padrão:
            vazio)
          required: false
          schema:
            type: string
            default: ''
            example: ''
      responses:
        '200':
          description: Lista de canais retornada com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: Lista de canais
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: Nome do canal
                        id:
                          type: string
                          description: ID do canal
                        type:
                          type: string
                          description: Tipo do canal
                          enum:
                            - Z_API
                            - WHATSAPP
                            - INSTAGRAM
                            - CLOUD_API
                            - TELEGRAM
                            - WIDGET
                            - MESSENGER
                            - MERCADO_LIVRE
                            - TWILIO_SMS
                        agentId:
                          type: string
                          nullable: true
                          description: ID do agente vinculado (quando houver)
                        agentPicture:
                          type: string
                          nullable: true
                          description: URL da foto do agente vinculado (quando houver)
                        agentName:
                          type: string
                          nullable: true
                          description: Nome do agente vinculado (quando houver)
                        facebookPageId:
                          type: string
                          nullable: true
                          description: ID da página do Facebook (quando aplicável)
                        connected:
                          type: boolean
                          description: Indica se o canal está conectado
                        username:
                          type: string
                          nullable: true
                          description: >-
                            Identificador do canal (ex.: telefone/usuário),
                            quando aplicável
                      additionalProperties: false
                  count:
                    type: integer
                    description: Quantidade total de canais retornados
                    example: 10
                additionalProperties: false
        '403':
          description: Erro de token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '500':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error403:
      required:
        - error
      type: object
      properties:
        error:
          type: string
    Error:
      required:
        - error
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````