Skip to main content
GET
/
v1
/
campaigns
Listar campañas masivas
curl --request GET \
  --url https://api-prod.studio.getsupervisor.ai/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "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
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-workspace-id
string<uuid>
required

Identificador del workspace multi-tenant.

Query Parameters

​
page
integer
default:1

Número de página (>= 1). Por defecto es 1.

Required range: x >= 1
​
limit
integer
default:20

Tamaño de página (1..100). Por defecto 20.

Required range: 1 <= x <= 100
​
sort
string

Lista separada por comas de campos a ordenar. Usa prefijo '-' para orden descendente.

Example:

"createdAt,-id"

​
fields
string

Lista separada por comas de campos a retornar (sparse fieldset).

Example:

"id,externalId,status"

​
include
string

Lista separada por comas de relaciones a cargar.

Example:

"messages,sender"

​
q
string

Búsqueda de texto global sobre campos soportados del recurso.

Example:

"soporte"

​
filter
string

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.

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%\"))"

Response

Listado paginado de campañas recientes.

​
data
object[]
required
​
meta
object
required