Saltar al contenido principal

Listar plantillas de email

GET/v1/mail-templates

Para desarrolladores

Descripción​

Devuelve una lista paginada de plantillas de email. Cada elemento omite el contenido de la plantilla (html y config). Para obtenerlo, consulte la plantilla con GET /v1/mail-templates/{template_id}.

Las plantillas se crean y editan también desde esta API. Publicar, despublicar y eliminar una plantilla se hace desde el panel.

Guía relacionada​

Autenticación​

Authorizationbearer tokenheaderobligatorio
API key con scope templates:read. Formato: Bearer <API_KEY>.
X-Instance-Slugstringheaderobligatorio
Identificador de su instancia. Ver Autenticación.

Request​

Query params:

pageinteger
Número de página; la primera es la 1. Default: 1.
page_sizeinteger
Tamaño de página, 1–100. Default: 10.
namestring | null
Filtra por nombre, con coincidencia parcial e insensible a mayúsculas (ver Filtros de texto). Los nombres no son únicos, así que puede devolver varias plantillas. Para referenciar una, use su id.
statusstring, enum: `draft | public` | null
Filtra por estado. Si se omite, no se filtra.

Response​

200 OKDevuelve una página de resultados: data con los elementos y pagination para pedir la siguiente. Cada elemento tiene los campos que siguen.
idintegersiempre presente
Identificador de la plantilla.
namestringsiempre presente
Nombre de la plantilla.
subjectstring | null
Asunto del correo.
preheaderstring | null
Texto que la bandeja de entrada muestra junto al asunto.
statusstring, enum: `draft | public`siempre presente
Una plantilla en draft solo se puede usar en un envío con test_mode: true.
descriptionstring | null
Descripción libre.
providerstring, enum: `fidelizador | bee`siempre presente
Editor de contenido con el que se creó. Una plantilla bee es de un editor que ya no se ofrece: se puede listar, publicar y enviar, pero no editar (template_read_only).
created_atstring (date-time)siempre presente
—
updated_atstring (date-time)siempre presente
—
Nota
Request
curl -X GET "https://$API_HOST/v1/mail-templates?status=public&page=1&page_size=10" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"
Response
{
"data": [
  {
    "id": 12,
    "name": "Welcome Email Template",
    "subject": "Welcome to Our Service!",
    "preheader": "Conoce todo lo que puedes hacer desde el primer día",
    "status": "public",
    "description": null,
    "provider": "fidelizador",
    "created_at": "2026-05-08T14:22:31Z",
    "updated_at": "2026-05-08T14:22:31Z"
  }
],
"pagination": {
  "page": 1,
  "page_size": 10,
  "has_more": false,
  "total_items": 1,
  "total_pages": 1
}
}