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

# Listar Campanas

> Servicio para listar todas las campanas de envio del workspace.



## OpenAPI

````yaml GET /api/conversation/campaign
openapi: 3.1.0
info:
  title: Plazbot
  description: >-
    Documentacion completa de la API de Plazbot. Incluye todos los servicios
    para gestion de contactos, conversaciones, mensajes, oportunidades, tareas,
    plantillas, agentes de IA, usuarios y workspaces.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.plazbot.com
    description: Servidor de produccion de Plazbot
security:
  - bearerAuth: []
tags:
  - name: automation
    description: Servicios de automatizacion y nodos de IA
  - name: agent
    description: Servicios para gestion de Agentes de Inteligencia Artificial
  - name: contact
    description: Servicios para gestion de contactos del workspace
  - name: conversation
    description: Servicios para gestion de conversaciones y campanas
  - name: message
    description: Servicios para envio y gestion de mensajes
  - name: opportunity
    description: Servicios para gestion de oportunidades de negocio
  - name: task
    description: Servicios para gestion de tareas
  - name: template
    description: Servicios para gestion de plantillas de WhatsApp
  - name: user
    description: Servicios para gestion de usuarios y autenticacion
  - name: workspace
    description: Servicios para gestion de workspaces
paths:
  /api/conversation/campaign:
    get:
      tags:
        - conversation
      summary: Listar Campanas
      description: Servicio para listar todas las campanas de envio del workspace.
      operationId: listCampaigns
      parameters:
        - name: workspaceId
          in: query
          description: Identificador del workspace
          required: true
          schema:
            type: string
        - name: x-workspace-id
          in: header
          description: Identificador del workspace
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Lista de campanas obtenida exitosamente
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indica si la operacion fue exitosa
                  code:
                    type: integer
                    description: Codigo HTTP de la respuesta
                  errorCode:
                    type:
                      - string
                      - 'null'
                    description: Codigo de error, null si no hay error
                  message:
                    type: string
                    description: Mensaje descriptivo del resultado
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: ID de la campana
                        name:
                          type: string
                          description: Nombre de la campana
                        status:
                          type: string
                          description: Estado de la campana
                        creationDate:
                          type: string
                          format: date-time
                          description: Fecha de creacion
                        totalContacts:
                          type: integer
                          description: Total de contactos en la campana
                required:
                  - success
                  - code
                  - errorCode
                  - message
                  - data
        '400':
          description: Solicitud incorrecta - Datos invalidos o faltantes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: No autorizado - Token Bearer requerido o invalido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Recurso no encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Error interno del servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      description: Respuesta de error estandar de la API
      properties:
        success:
          type: boolean
          description: Siempre false en errores
        code:
          type: integer
          description: Codigo HTTP del error
        errorCode:
          type:
            - string
            - 'null'
          description: Codigo de error especifico
        message:
          type: string
          description: Mensaje descriptivo del error
      required:
        - success
        - code
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Token de autenticacion Bearer. Obtenga el token usando el endpoint
        /api/user/login

````