Obtener una página de suscripción

GET /api/v1/signup-pages/{id} Una página de suscripción, con su content: esta es la llamada que te da el HTML que la lista no lleva.

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 ruta

ParámetroTipoDescripción
idstringObligatorio. La página que se lee

Ejemplo

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/signup-pages/$SIGNUP_PAGE_ID"

Respuesta

  • 200 OK: la página y su HTML.
  • 401 Unauthorized: clave ausente o no válida, o su propietario dejó la organización.
  • 404 Not Found: no existe esa página, o pertenece a otra organización. La API nunca confirma que un id existe a quien no tiene derecho sobre él.
  • 429 Too Many Requests: la clave superó su límite de peticiones.

Campos de la respuesta

CampoTipoDescripción
successbooleanIndica si la operación tuvo éxito
data.idstringIdentificador único de la página
data.namestringNombre interno, el que solo ve tu equipo
data.slugstringÚltima parte de la dirección pública
data.statusstringdraft o published
data.listIdstringLa lista que recibe a los suscriptores
data.contentstringEl HTML de la página
data.sourceTemplateNamestring | nullEl tema del que se copió, null para HTML pegado
data.heroTitlestringEl título que leen los visitantes
data.heroSubtitlestring | nullEl subtítulo, null si no está definido
data.submitLabelstringTexto del botón de suscripción
data.successMessagestringSe muestra tras una suscripción cuando no hay redirección
data.redirectUrlstring | nullAdónde va el visitante tras suscribirse, null si no hay ninguna
data.collectFirstNamebooleanSi el formulario pide el nombre
data.collectLastNamebooleanSi el formulario pide el apellido
data.createdAtstringFecha de creación ISO
data.updatedAtstringFecha ISO del último cambio

Ejemplo de respuesta

json
{
  "success": true,
  "data": {
    "id": "3d3d3d3d-4444-4eee-9fff-000011112222",
    "name": "Newsletter footer",
    "slug": "newsletter",
    "status": "published",
    "listId": "9f8e7d6c-1111-4bbb-8ccc-ddddeeeeffff",
    "content": "<html><body><h1>{{heroTitle}}</h1>{{form}}</body></html>",
    "sourceTemplateName": "Minimal",
    "heroTitle": "Join the list",
    "heroSubtitle": "One email a month, no more.",
    "submitLabel": "Sign me up",
    "successMessage": "Check your inbox.",
    "redirectUrl": null,
    "collectFirstName": true,
    "collectLastName": false,
    "createdAt": "2026-08-01T10:00:00.000Z",
    "updatedAt": "2026-08-02T10:00:00.000Z"
  }
}

Notas

  • La organización nunca está en la respuesta. Es la que abre tu clave, y ya la conoces.
  • Una página en draft responde 200 aquí aunque su dirección pública responda con una página de no encontrado. Son dos preguntas distintas.

Relacionado