For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterAPI KeysStatusSign In
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Introduction
    • Getting started
  • Email API
      • GETGet the list of email templates
      • DELDelete an inactive email template
      • POSTSend a template to your test list
      • POSTGenerate the rendered preview of transactional template
      • PUTUpdate an email template
      • GETReturns the template information
      • POSTCreate an email template
  • Transactional SMS
  • Transactional WhatsApp
  • Marketing Campaigns
  • Contact Management
  • Events
    • GETGet events
    • POSTCreate an event
    • POSTCreate events in batch
  • Object Management
  • Accounts and Settings
  • Sales CRM
  • Conversations
  • Ecommerce
  • Loyalty
LogoLogo
Help CenterAPI KeysStatusSign In
Email APIEmail templates

Returns the template information

GET
https://api.brevo.com/v3/smtp/templates/:templateId
GET
/v3/smtp/templates/:templateId
1import { BrevoClient } from "@getbrevo/brevo";
2
3async function main() {
4    const client = new BrevoClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.transactionalEmails.getSmtpTemplate(1);
8}
9main();
1{
2  "createdAt": "2016-02-25T11:53:26Z",
3  "htmlContent": "HTML CONTENT 4",
4  "id": 33,
5  "isActive": true,
6  "modifiedAt": "2016-02-25T11:53:26Z",
7  "name": "OrderConfirmation",
8  "replyTo": "replyto@domain.com",
9  "sender": {
10    "email": "john.smith@example.com",
11    "id": "26",
12    "name": "John"
13  },
14  "subject": "Order Confirmation : Thanks for your Purchase !",
15  "tag": "",
16  "testSent": false,
17  "toField": "",
18  "doiTemplate": false
19}
Retrieve the full details of a specific transactional email template by its numeric ID or custom template identifier string. The response includes the template name, subject, sender information, HTML content, active status, creation and modification timestamps, reply-to address, tag, and a `doiTemplate` flag indicating whether the template is a double opt-in template (detected by the presence of optin-related tags or variables in the content).
Was this page helpful?
Previous

Create an email template

Next
Built with

Retrieve the full details of a specific transactional email template by its numeric ID or custom template identifier string. The response includes the template name, subject, sender information, HTML content, active status, creation and modification timestamps, reply-to address, tag, and a doiTemplate flag indicating whether the template is a double opt-in template (detected by the presence of optin-related tags or variables in the content).

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

templateIdlong or stringRequired

ID of the template. Can be a numeric template ID or a custom template identifier string (alphanumeric, hyphens, and underscores only, max 64 characters, must start with a letter).

Response

Email template informations
createdAtstring

Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ)

htmlContentstring
HTML content of the template
idlong
ID of the template
isActiveboolean

Status of template (true=active, false=inactive)

modifiedAtstring

Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ)

namestring
Name of the template
replyTostringformat: "email"
Email defined as the "Reply to" for the template
senderobject
subjectstring
Subject of the template
tagstring
Tag of the template
testSentboolean

Status of test sending for the template (true=test email has been sent, false=test email has not been sent)

toFieldstring
Customisation of the "to" field for the template
doiTemplateboolean

It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call.

customTemplateIdstring
Custom template identifier, if one was assigned during template creation. Only present when the template has a custom ID.

Errors

400
Bad Request Error
404
Not Found Error