Explorar la galería

GET /api/v1/template-gallery Los modelos llegan en el orden de la galería: position y después name.
json
{
  "success": true,
  "data": [
    {
      "id": "…",
      "name": "Plain letter",
      "description": "A one-column letter",
      "defaultSubject": "News of the month",
      "content": "<html>…</html>",
      "previewImageUrl": "https://…/plain-letter.png",
      "colorScheme": "fixed",
      "position": 3,
      "createdAt": "…",
      "updatedAt": "…"
    }
  ],
  "pagination": {"total": 1, "page": 1, "limit": 20, "totalPages": 1}
}
colorScheme se lee del HTML en cada solicitud, nunca se guarda: adaptive significa que el modelo lleva sus propias reglas de modo oscuro, fixed significa que se ve igual en todas partes. Si editas tu copia más tarde, esa respuesta se refiere al modelo del que partiste, no a lo que hiciste con él.

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 sobre AgentsMail en sí. Consulta Claves de API.

Parámetros de consulta

ParámetroTipoDescripción
pagenumberPor defecto 1
limitnumberPor defecto 20, con un máximo de 100

Ejemplo

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/template-gallery"

Respuesta

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

Campos de la respuesta

CampoTipoDescripción
successbooleanIndica si la operación se realizó correctamente
data[].idstringIdentificador único del diseño
data[].namestringSu nombre
data[].defaultSubjectstringAsunto con el que viene
data[].thumbnailUrlstringnull
paginationobject{total, page, limit, totalPages}

Ejemplo de respuesta

json
{
  "success": true,
  "data": [
    {
      "id": "4d19c0a2",
      "name": "Newsletter",
      "defaultSubject": "August news",
      "thumbnailUrl": "value"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

Relacionado