پرش به مستندات
API

دریافت یک قالب

شناسه یا slug را می‌پذیرد. تازه‌ترین نسخه به‌طور کامل و همراه با بدنه برمی‌گردد.

GETapi.openemail.uk/templates/{id}

فراخوانی واقعی را با کلید خودتان روی فضای کاری شما اجرا می‌کند.

GET /templates/{id}

شناسه یا slug را می‌پذیرد. تازه‌ترین نسخه به‌طور کامل و همراه با بدنه برمی‌گردد.

نمونه

به templates:read نیاز دارد. شناسه‌ها پیشوند tpl_ دارند و slugها نمی‌توانند داشته باشند، پس این دو واژگان روی این مسیر هرگز با هم برخورد نمی‌کنند.

curl
curl "$OE/templates/order-shipped" -H "$AUTH"
پاسخ
{  "object": "template",  "id": "tpl_9c1f0a4b7e05d3862c1f0a44",  "name": "Order shipped",  "slug": "order-shipped",  "status": "active",  "publishedVersion": 3,  "latestVersion": 4,  "subject": "Order {{orderId}} is on its way",  "engine": "html",  "slots": [],  "props": [{ "key": "orderId", "kind": "text", "required": true, "default": null }],  "latest": {    "object": "template_version",    "id": "tplv_5d31c2a8…",    "templateId": "tpl_9c1f0a4b7e05d3862c1f0a44",    "version": 4,    "state": "draft",    "engine": "html",    "subject": "Order {{orderId}} is on its way",    "slots": [],    "props": [{ "key": "orderId", "kind": "text", "required": true, "default": null }],    "document": null,    "html": "<p>Hello {{customer}}, {{orderId}} left the warehouse.</p>",    "createdAt": "2026-08-28T16:03:10.000Z",    "publishedAt": null  },  "createdAt": "2026-08-01T09:12:44.000Z",  "updatedAt": "2026-08-28T16:03:10.000Z"}

latest تازه‌ترین نسخه است، که وقتی ویرایشی منتشرنشده در کار باشد همان پیش‌نویس است. فیلدهای کنارش (subject، engine، slots، props) نسخهٔ منتشرشده را توصیف می‌کنند، چون همان است که یک ارسال به آن می‌رسد.

document درخت بلوک‌هاست و زیر engine: "html" مقدار null دارد؛ html همان نشانه‌گذاری ثبت‌شده است و زیر engine: "blocks" مقدار null دارد. فقط یک دریافت تکی هر یک از این دو را حمل می‌کند. فهرستی از نسخه‌ها که هر کدام یک درخت کامل داشته باشند، باری است که کسی نخواسته.