Skip to content

Email templates

If you have questions regarding this API, please visit our API FAQ page.

Email templates are built in the Inboxroad template builder. This endpoint is read-only — templates cannot be created or edited through the API. A template’s id is what you pass as welcome_email_template_id when creating or updating a contacts list, and as the double opt-in email_template_id.

Listing email templates

Make a GET request to https://webapi.inboxroad.com/api/v2/email-templates/ with a valid X-API-Key (see v2 authentication).

Terminal window
curl -X GET 'https://webapi.inboxroad.com/api/v2/email-templates/' \
-H 'X-API-Key: <your_token>' \
-H 'Content-Type: application/json'

Returns 200 with an array of email template objects (not paginated).

Query parameters

Param namePossible valuesDescription
categoriesnewsletters, workflows, transactionalFilter by category. Repeat to pass more than one.
orderingasc, descSort direction. Default desc.
order_byname, categories, template_type, created_at, updated_atField to sort by. Default created_at.

For example:

Terminal window
curl -X GET 'https://webapi.inboxroad.com/api/v2/email-templates/?categories=newsletters&categories=transactional&order_by=name&ordering=asc' \
-H 'X-API-Key: <your_token>' \
-H 'Content-Type: application/json'

Email template object

Field nameDescription
idUnique identifier of the template (UUID).
nameHuman-readable name of the template.
htmlRendered HTML body.
text_contentPlain-text body.
json_dataBuilder design document used to regenerate the template.
template_typeOne of plain, html, unlayer.
categoriesArray of categories the template belongs to: newsletters, workflows, transactional.
created_atDate and time the template was created.
updated_atDate and time the template was last updated.

Example response

[
{
"id": "7d1f0a2b-3c4d-5e6f-7a8b-9c0d1e2f3a4b",
"name": "Welcome – Newsletter",
"html": "<html><body>Welcome aboard!</body></html>",
"text_content": "Welcome aboard!",
"json_data": { "body": { "rows": [] } },
"template_type": "unlayer",
"categories": ["newsletters"],
"created_at": "2026-05-01T08:30:00Z",
"updated_at": "2026-05-12T10:15:00Z"
}
]

To find where a specific template is used, see Template usage.

Possible response codes

Status codeDescription
200Email templates retrieved successfully.
401Unauthorized.