Read template

GET

/templates/{filename}

Last modified:2026-10-04 00:01:37

OperationId:ReadTemplate

Returns the details of one stored template, such as an HTML email template or the Word fax cover letter: who it applies to, its media type and size, and a link that downloads the file. The response is JSON. The template file itself is not in it; download it from file-access-url.

Requires Super User, Super User Read Only, or Reseller scope. A Super User and a Super User Read Only can read every template. A Reseller can read templates stored for its own reseller or for a domain in it, and templates that apply to every reseller. Other scopes get 403.

A template is stored per reseller, domain, and server, and each defaults to *, meaning all. The values are matched exactly here: a template stored for every domain is not found when you name one domain. Name the reseller, domain, and server in the query string to read a copy stored for them.

When the platform sends an email, it uses the most specific copy instead: a copy for the sending server first, then one for the reseller, then one for the domain, falling back to * at each level. To override a template for one domain, store it with both reseller and domain set.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Responses

🟢200OK

application/json

The template's details. Download the file from file-access-url.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/templates/welcome_email.php?reseller=example-reseller&domain=*&server=*' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Reseller welcome email

{
    "reseller": "example-reseller",
    "domain": "*",
    "server": "*",
    "description": "Welcome email for new users",
    "file-mime-type": "text/html",
    "file-size-bytes": 6214,
    "file-access-url": "https://core1.example.com/ns-api?object=image&action=read&filename=welcome_email.php&server=%2A&territory=example-reseller&domain=%2A"
}

Modified at 2026-10-04 00:01:37

Update image

Delete template