latestOpenAPI 3.1.0MIT2026-08-103050171.2 KB

ebcbb377ee0f

Templates

Get template

Retrieve a named template for a specific domain for the specified service.

get/services/{serviceId}/domains/{domainName}/templates/{templateName}

Path parameters

serviceIdstring required
Example:01GVRB50KEQFFE1SGMPFRNBG6J

The serviceId containing the templates you want to list.

domainNamestring required
Example:yourdomain.com

The name of the domain containing the template you want to get.

templateName'successful outbound fax' | 'unsuccessful outbound fax' | 'successful inbound fax' | 'unsuccessful inbound fax' required

The name of the email template.

Example:successful outbound fax

The name of the template you want to get.

Response

The returned template.

Example response

{
  "template": {
    "name": "successful outbound fax",
    "createdAt": "2025-10-24 19:11:50.235000+00:00",
    "id": "8836986f-050c-4b2d-afb9-8069d1520b17",
    "version": {
      "tag": "initial",
      "template": "<!DOCTYPE html><html lang='en'><head><meta charset='utf-8'><meta name='viewport' content='width=device-width'></head><body style='margin:0;padding:0;background:#f3f4f6;'><table role='presentation' width='100%' cellpadding='0' cellspacing='0' style='background:#f3f4f6;'><tr><td align='center' style='padding:24px;'><table role='presentation' width='100%' cellpadding='0' cellspacing='0' style='max-width:600px;background:#ffffff;border-radius:8px;border:1px solid #e5e7eb;'><tr><td style='padding:24px 28px;font-family:Segoe UI,Helvetica,Arial,sans-serif;color:#111827;font-size:14px;line-height:1.5;'><p style='margin:0 0 16px 0;'>Hi,</p><p style='margin:0 0 20px 0;'>You have sent a successful fax to: <strong>{{to}}</strong>!</p><table role='presentation' cellpadding='0' cellspacing='0' style='border-collapse:collapse;'><tr><td style='padding:0 10px 6px 0;font-weight:600;'>Fax Id:</td><td style='padding:0 0 6px 0;'>{{id}}</td></tr><tr><td style='padding:0 10px 6px 0;font-weight:600;'>From:</td><td style='padding:0 0 6px 0;'>{{from}}</td></tr><tr><td style='padding:0 10px 6px 0;font-weight:600;'>To:</td><td style='padding:0 0 6px 0;'>{{to}}</td></tr><tr><td style='padding:0 10px 6px 0;font-weight:600;'>Number of pages:</td><td style='padding:0 0 6px 0;'>{{numberOfPages}}</td></tr><tr><td style='padding:0 10px 6px 0;font-weight:600;'>Completed at:</td><td style='padding:0 0 6px 0;'>{{completedTime}}</td></tr><tr><td style='padding:0 10px 0 0;font-weight:600;'>Price:</td><td style='padding:0 0 0 0;'>{{currencyCode}} {{amount}}</td></tr></table><p style='margin:20px 0 0 0;'>Thanks!</p></td></tr></table></td></tr></table></body></html>",
      "createdAt": "2025-10-24 19:11:50.235000+00:00",
      "active": true,
      "id": "fa01442c-e3d5-482b-be67-e3fdda931b00"
    }
  }
}