> ## Documentation Index > Fetch the complete documentation index at: https://docs.getsupervisor.ai/llms.txt > Use this file to discover all available pages before exploring further. # Listar campañas masivas > Retorna campañas ejecutadas mediante cargas CSV para un workspace. Soporta filtros, ordenamientos y paginación siguiendo la convención descrita en `docs/api-query-builder.md`. Requiere el scope `campaigns:read`. ## OpenAPI ````yaml /openapi/public-api.yaml get /v1/campaigns openapi: 3.1.0 info: title: Agents Studio API version: 1.0.0 description: > API del backend de Agents Studio. Expone servicios multi-tenant para gestionar agentes (texto y voz), catálogo de herramientas, habilitación de workspaces y operaciones de telefonía. Todos los endpoints requieren autenticación Bearer y respetan los contratos documentados en `docs/modules`. license: name: Proprietary url: https://getsupervisor.ai/legal/terms servers: - url: https://api-prod.studio.getsupervisor.ai description: Producción - url: https://sandbox.agents.studio.getsupervisor.ai description: Sandbox security: - BearerAuth: [] tags: - name: Agents description: > Gestión general de agentes y sus metadatos. Scopes requeridos: `agents:read` para consultas y `agents:write` para creación, actualización y operaciones sobre teléfonos. - name: Agent Versions description: Versionado y mantenimiento de versiones publicadas de los agentes. - name: Agent Schedules description: >- Configuración de horarios regulares y excepciones puntuales para controlar la disponibilidad de los agentes. - name: Agent Knowledge description: Uploads y sincronización de knowledge bases asociadas al agente. - name: Agent Tags description: Gestión de etiquetas asociadas a agentes. - name: Campaigns description: > Gestión de campañas masivas basadas en CSV para ejecutar agentes de forma batch. Scopes requeridos: `campaigns:read` para consultas y `campaigns:write` para creación. - name: Calls description: | Consultas de llamadas (Speech Analytics) disponibles para el workspace. Scopes requeridos: `calls:read`. - name: Knowledge description: Gestión de recursos de conocimiento asociados a tools. - name: Agent Instructions description: > Operaciones sobre instrucciones (prompt) gestionadas por los usuarios finales para guiar y corregir el comportamiento del agente. Las instrucciones se aplican a la versión activa del agente, se mantienen como texto libre sin formato (1 a 500 caracteres) y su prioridad se controla mediante el campo `order`. Scopes requeridos: `agent-instructions:read` para consultas y `agent-instructions:write` para creación o edición. - name: Voices description: Catálogo consolidado de voces provenientes de proveedores externos. - name: Catalogs description: > Gestión centralizada de catálogos (idiomas, tonos, voces, etiquetas) con alcance global o específico por workspace. Scopes requeridos: `catalogs:read` para consultas y `catalogs:write` para creación y modificaciones. - name: Agent Phones description: Conexión y desconexión de teléfonos asignados a agentes. - name: API Keys description: Gestión de credenciales de acceso programático y sus permisos. - name: Agent Blueprints description: > Gestión del blueprint (personalidad) asociado a cada versión de agente. Scopes requeridos: `agent-blueprints:read` para lectura y `agent-blueprints:write` para cambios en blueprint. - name: Agent Stages description: > Autoría de stages del blueprint del agente, abarcando orden, prompts y validaciones previas a la publicación. Scopes requeridos: `stages:read` para consultas y `stages:write` para creación y edición. La validación se ejecuta automáticamente en cada mutación y la sincronización con proveedores sucede mediante jobs internos tras los cambios. - name: Stage Triggers description: > Gestión detallada de triggers que conectan stages dentro del blueprint y definen las transiciones conversacionales. Scopes requeridos: `stage-triggers:*` (o políticas equivalentes bajo `stages:*`). - name: Workspaces description: Gestión multi-tenant y habilitación de credenciales por workspace. - name: Tools description: > Catálogo y ejecución de tools disponibles para los agentes. Scopes requeridos: `tools:read` para listar y `tools:execute` para ejecutar tools. - name: Webhooks description: > Gestión de webhooks por workspace para suscribirse a eventos del dominio y recibir notificaciones HTTP. Scopes requeridos: `webhooks:read` para consultas y `webhooks:write` para crear, actualizar o eliminar webhooks y suscripciones. paths: /v1/campaigns: get: tags: - Campaigns summary: Listar campañas masivas description: > Retorna campañas ejecutadas mediante cargas CSV para un workspace. Soporta filtros, ordenamientos y paginación siguiendo la convención descrita en `docs/api-query-builder.md`. Requiere el scope `campaigns:read`. operationId: listCampaigns parameters: - $ref: '#/components/parameters/XWorkspaceId' - $ref: '#/components/parameters/PageParam' - $ref: '#/components/parameters/LimitParam' - $ref: '#/components/parameters/SortParam' - $ref: '#/components/parameters/FieldsParam' - $ref: '#/components/parameters/IncludeParam' - $ref: '#/components/parameters/SearchParam' - $ref: '#/components/parameters/FilterParam' responses: '200': description: Listado paginado de campañas recientes. content: application/json: schema: $ref: '#/components/schemas/CampaignListResponse' examples: default: summary: Campañas recientes value: data: - campaignId: 0f6c4fb5-e0ad-4cf8-bf0c-bc7663bc7e71 workspaceId: c55f6f92-5e96-4011-9a94-a4ce91bc68fc agentId: 8a540b3d-6b24-4dd8-9fe8-4f2edbf2e41f agentVersionId: cce0e619-6b25-4e20-b31e-89e5ed1239b6 name: Campaña outbound noviembre objective: Validar rendimiento de script de retención status: PROCESSING inputFileKey: workspaces/c55f6f92/campaigns/2025/11/input.csv totalRecords: 250 processedRecords: 120 successfulRecords: 95 failedRecords: 25 createdAt: '2025-11-28T10:00:00.000Z' updatedAt: '2025-11-28T10:45:00.000Z' meta: total: 2 page: 1 limit: 20 hasNext: false hasPrevious: false '400': description: Parámetros de consulta inválidos. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: parameters: XWorkspaceId: name: x-workspace-id in: header required: true description: Identificador del workspace multi-tenant. schema: type: string format: uuid PageParam: name: page in: query required: false description: Número de página (>= 1). Por defecto es 1. schema: type: integer minimum: 1 default: 1 LimitParam: name: limit in: query required: false description: Tamaño de página (1..100). Por defecto 20. schema: type: integer minimum: 1 maximum: 100 default: 20 SortParam: name: sort in: query required: false description: >- Lista separada por comas de campos a ordenar. Usa prefijo '-' para orden descendente. schema: type: string example: createdAt,-id FieldsParam: name: fields in: query required: false description: Lista separada por comas de campos a retornar (sparse fieldset). schema: type: string example: id,externalId,status IncludeParam: name: include in: query required: false description: Lista separada por comas de relaciones a cargar. schema: type: string example: messages,sender SearchParam: name: q in: query required: false description: Búsqueda de texto global sobre campos soportados del recurso. schema: type: string example: soporte FilterParam: name: filter in: query required: false description: > Expresión de filtros combinados generada con el API Query Builder. Utiliza funciones como `and(...)`, `or(...)`, `eq(...)`, `like(...)`, etc. Consulta `docs/api-query-builder.md` para la gramática completa y ejemplos adicionales. schema: $ref: '#/components/schemas/QueryFilters' examples: estadoActivoConNombre: summary: Filtrar agentes activos cuyo nombre contiene "ventas" value: and(eq(status,"active"),like(name,"%ventas%")) schemas: CampaignListResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/Campaign' meta: $ref: '#/components/schemas/PaginationMeta' required: - data - meta ErrorResponse: type: object properties: code: type: string description: Código principal del error (alto nivel). message: type: string description: Mensaje legible para humanos. details: type: object description: > Información adicional específica del error. Cuando aplique, `details.subcode` provee un identificador estable para que el frontend decida qué UI mostrar. properties: subcode: type: string description: >- Identificador específico del error (p.ej. `WORKSPACE_NOT_PROVISIONED`). workspaceId: type: string format: uuid description: Identificador de workspace relacionado cuando aplica. additionalProperties: true required: - code - message QueryFilters: type: string description: > Expresión string compatible con el API Query Builder. Soporta composición de funciones (`and`, `or`) y operadores (`eq`, `like`, `between`, etc.) para filtrar resultados. example: and(eq(status,"active"),like(name,"%ventas%")) Campaign: type: object properties: campaignId: type: string format: uuid workspaceId: type: string format: uuid agentId: type: string format: uuid agentVersionId: type: string format: uuid name: type: string minLength: 1 objective: type: - string - 'null' description: Objetivo opcional que se desea medir con la campaña. status: $ref: '#/components/schemas/CampaignStatus' inputFileKey: type: string description: Ruta en storage del CSV original. totalRecords: type: integer minimum: 0 processedRecords: type: integer minimum: 0 successfulRecords: type: integer minimum: 0 failedRecords: type: integer minimum: 0 createdAt: type: string format: date-time updatedAt: type: string format: date-time startedAt: type: - string - 'null' format: date-time completedAt: type: - string - 'null' format: date-time required: - campaignId - workspaceId - agentId - agentVersionId - name - status - inputFileKey - totalRecords - processedRecords - successfulRecords - failedRecords - createdAt - updatedAt additionalProperties: false PaginationMeta: type: object properties: total: type: integer page: type: integer limit: type: integer hasNext: type: boolean hasPrevious: type: boolean description: Indica si existe una página previa a la actual. required: - total - page - limit - hasNext - hasPrevious CampaignStatus: type: string description: Estado del procesamiento batch de la campaña. enum: - PENDING - PROCESSING - COMPLETED - FAILED - PARTIALLY_COMPLETED securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT ````