Listar campañas

GET /api/v1/campaigns Lista las campañas de tu organización, con el texto de vista previa guardado bajo sus dos nombres compatibles.

Autorización

Rol en la organizaciónEste endpoint
OWNERPermitido
ADMINPermitido
MEMBERPermitido
Una clave lleva el rol que su creador tiene en esta organización, nunca un rol en AgentsMail en sí. Consulta Claves de API.

Parámetros de consulta

ParámetroTipoDescripción
statusstringdraft, scheduled, paused, sending, sent, failed
searchstringCoincide con el nombre de la campaña, sin distinguir mayúsculas
pagenumberPor defecto 1
limitnumberPor defecto 20, máximo 100

Ejemplo

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/campaigns?status=sent&limit=20"

Respuesta

  • 200 OK: la llamada tuvo éxito.
  • 401 Unauthorized: clave ausente o no válida, o su propietario dejó la organización.
  • 429 Too Many Requests: más de 120 solicitudes en un minuto para esta clave.

Campos de la respuesta

data es un array de campañas, con un objeto pagination al lado.
CampoTipoDescripción
successbooleanIndica si la operación tuvo éxito
dataarrayObjetos de campaña.
data[].campaignUrlstring | nullPágina de la campaña.
data[].campaignEditorUrlstring | nullEditor del contenido de un borrador editable.
data[].campaignStatsUrlstring | nullEstadísticas de una campaña enviada.
data[].campaignPreviewUrlstring | nullVista previa interna de una campaña enviada.
data[].publicCampaignUrlstring | nullArchivo compartible de una campaña enviada con archivos públicos activados.
data[].idstringIdentificador de la campaña
data[].namestringSu nombre interno
data[].subjectstringEl asunto que ven los destinatarios
data[].previewTextstring | nullTexto de vista previa guardado
data[].preheaderstring | nullAlias compatible, igual a data[].previewText
data[].statusstringdraft, scheduled, paused, sending, sent, failed
data[].listIdstringLa lista a la que apunta
data[].tagIdstring | nullEtiqueta opcional que limita el público.
data[].topicIdstring | nullEl tema editorial que lleva, si lo hay
data[].scheduledAtstring \null
data[].sentAtstring \null
data[].createdAt / updatedAtstringFechas ISO
paginationobject{total, page, limit, totalPages}
Los cinco enlaces son URL absolutas en el idioma de la organización (en por defecto). Los enlaces no disponibles son null; todos son null si la organización no tiene slug de URL. Los enlaces internos requieren iniciar sesión y tener acceso a la organización; solo publicCampaignUrl es público. Los agentes API y MCP muestran las URL pertinentes no nulas como enlaces Markdown, por ejemplo [Abrir campaña](campaignUrl) con la URL recibida. Crear o consultar una campaña no la publica.

Ejemplo de respuesta

json
{
  "success": true,
  "data": [
    {
      "id": "4d19c0a2",
      "name": "Newsletter",
      "subject": "August news",
      "previewText": "Three new things this month",
      "preheader": "Three new things this month",
      "status": "sent",
      "listId": "0b7c51e8",
      "scheduledAt": "2026-08-23T10:22:05.000Z",
      "sentAt": "2026-08-23T10:22:05.000Z",
      "tagId": null,
      "createdAt": "2026-08-23T10:20:05.000Z",
      "updatedAt": "2026-08-23T10:22:05.000Z",
      "campaignUrl": "https://www.agentsmail.io/es/team/my-team/campaigns/4d19c0a2",
      "campaignEditorUrl": null,
      "campaignStatsUrl": "https://www.agentsmail.io/es/team/my-team/campaigns/4d19c0a2/stats",
      "campaignPreviewUrl": "https://www.agentsmail.io/es/team/my-team/campaigns/4d19c0a2/preview",
      "publicCampaignUrl": "https://www.agentsmail.io/es/public/my-team/newsletter"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

Relacionado