Listar plantillas de email

GET/v1/mail-templates

Descripción

Retorna una lista paginada de plantillas de email. Cada elemento omite el contenido de la plantilla (html y config); para obtenerlo se consulta la plantilla por su id.

Autenticación

Authorizationbearer tokenheaderobligatorio

API key con scope templates:read. Formato: Bearer FD.<key_id>.<token>.

X-Instance-Slugstringheaderobligatorio

Request

Query params:

pageinteger

Página, 1-indexed. Default: 1.

page_sizeinteger

Tamaño de página, 1–100. Default: 10.

namestring | null

Filtra por nombre - coincidencia parcial, insensible a mayúsculas (ver Filtros de texto). Los nombres no son únicos, así que puede devolver varias plantillas: para referenciar una, usar su id.

statusstring, enum: `draft | public` | null

Filtra por estado. Omitido: sin filtro.

Response

200 OK

Cada elemento de data tiene los mismos campos que la respuesta de GET /v1/mail-templates/{template_id} — ver esa tabla — menos html y config, que solo devuelve esa consulta por id. El envelope {data, pagination} es el estándar de toda colección de la API — semántica completa en Paginación y formato de respuesta.

idintegerobligatorio

Identificador de la plantilla.

namestringobligatorio

Nombre de la plantilla.

subjectstring | null

Asunto del email.

statusstring, enum: `draft | public`obligatorio

Una plantilla en draft no se puede usar en un envío.

descriptionstring | null

Descripción libre.

providerstring, enum: `bee | ckeditor`obligatorio

Editor de contenido con el que se creó.

htmlstring | null

Contenido HTML. Solo lo devuelve esta consulta: el listado lo omite.

configobject | null

Configuración JSON del editor. Solo lo devuelve esta consulta: el listado lo omite.

created_atstring (date-time)obligatorio

—

updated_atstring (date-time)obligatorio

—

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!",
    "status": "public",
    "description": null,
    "provider": "bee",
    "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
}
}