Resources
🤖 For AI agents: The complete documentation index is available at /docs/llms.txt. A markdown version of this page is available at /docs/apis/emails/retrieve-an-email-template.md.

Retrieve an Email Template

Edit on GitHub
View Markdown

This API is used to retrieve one or all of the configured Email Templates. Specifying an Id on the URI will retrieve a single Email Template. Leaving off the Id will retrieve all of the Email Templates.

Request#

Global API Key Authentication
Retrieve all of the Email Templates
GET/api/email/template
OpenAPI Spec
Global API Key Authentication
Retrieve a single Email Template by Id
GET/api/email/template/{emailTemplateId}
OpenAPI Spec

Request Parameters#

emailTemplateId UUID optional

The Id of the Email Template to retrieve.

Response#

The response for this API contains either a single Email Template or all of the Email Templates. When you call this API with an Id the response will contain just that Email Template. When you call this API without an Id the response will contain all of the Email Templates. Both response types are defined below along with an example JSON response.

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
401You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404The object you requested doesn't exist. The response will be empty.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

emailTemplate.defaultFromName String

The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).

emailTemplate.defaultHtmlTemplate String

The default HTML Email Template.

emailTemplate.defaultSubject String

The default Subject used when sending emails.

emailTemplate.defaultTextTemplate String

The default Text Email Template.

emailTemplate.fromEmail String

The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).

emailTemplate.id UUID

The Id of Email Template.

emailTemplate.insertInstant Long

The instant when the Email Template was created.

emailTemplate.lastUpdateInstant Long

The instant when the Email Template was last updated.

emailTemplate.localizedFromNames Map<Locale,String>

The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user's list of preferred languages.

emailTemplate.localizedHtmlTemplates Map<Locale,String>

The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user's list of preferred languages.

emailTemplate.localizedSubjects Map<Locale,String>

The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user's list of preferred languages.

emailTemplate.localizedTextTemplates Map<Locale,String>

The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user's list of preferred languages.

emailTemplate.name String

A descriptive name for the email template (i.e. "April 2016 Coupon Email").

Example Response JSON for a Single Email Template

{
  "emailTemplate": {
    "defaultFromName": "Administrator",
    "defaultHtmlTemplate": "<p>Hello ${user.username}</p><p>Welcome To FusionAuth!</p>",
    "defaultSubject": "Hello World",
    "defaultTextTemplate": "Hello ${user.username},\nWelcome To FusionAuth!",
    "fromEmail": "email@example.com",
    "id": "00000000-0000-0000-0000-0000000000ab",
    "insertInstant": 1572469040579,
    "lastUpdateInstant": 1572477740579,
    "localizedFromNames": {
      "de": "Verwalter",
      "fr": "Administrateur"
    },
    "localizedHtmlTemplates": {
      "de": "<p>Hallo ${user.username}</p><p>Willkommen auf der FusionAuth!<p>",
      "fr": "<p>Bonjour ${user.username}</p><p>Bienvenue à FusionAuth!<p>"
    },
    "localizedSubjects": {
      "de": "Hallo Welt",
      "fr": "Bonjour le monde"
    },
    "localizedTextTemplates": {
      "de": "Hallo ${user.username},\nWillkommen auf der FusionAuth!",
      "fr": "Bonjour ${user.username},\nBienvenue à FusionAuth!"
    },
    "name": "Hello World"
  }
}

Response Body#

emailTemplates Array

The list of all the Email Templates.

emailTemplates[x].defaultFromName String

The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).

emailTemplates[x].defaultHtmlTemplate String

The default HTML Email Template.

emailTemplates[x].defaultSubject String

The default Subject used when sending emails.

emailTemplates[x].defaultTextTemplate String

The default Text Email Template.

emailTemplates[x].fromEmail String

The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).

emailTemplates[x].id UUID

The Id of Email Template.

emailTemplates[x].insertInstant Long

The instant when the Email Template was created.

emailTemplates[x].lastUpdateInstant Long

The instant when the Email Template was last updated.

emailTemplates[x].localizedFromNames Map<Locale,String>

The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user's list of preferred languages.

emailTemplates[x].localizedHtmlTemplates Map<Locale,String>

The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user's list of preferred languages.

emailTemplates[x].localizedSubjects Map<Locale,String>

The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user's list of preferred languages.

emailTemplates[x].localizedTextTemplates Map<Locale,String>

The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user's list of preferred languages.

emailTemplates[x].name String

A descriptive name for the email template (i.e. "April 2016 Coupon Email").

Example Response JSON for all the Email Templates

{
  "emailTemplates": [
    {
      "defaultFromName": "Administrator",
      "defaultHtmlTemplate": "<p>Hello ${user.username}</p><p>Welcome To FusionAuth!</p>",
      "defaultSubject": "Hello World",
      "defaultTextTemplate": "Hello ${user.username},\nWelcome To FusionAuth!",
      "fromEmail": "email@example.com",
      "id": "00000000-0000-0000-0000-0000000000ab",
      "insertInstant": 1572469040579,
      "lastUpdateInstant": 1572477740579,
      "localizedFromNames": {
        "de": "Verwalter",
        "fr": "Administrateur"
      },
      "localizedHtmlTemplates": {
        "de": "<p>Hallo ${user.username}</p><p>Willkommen auf der FusionAuth!<p>",
        "fr": "<p>Bonjour ${user.username}</p><p>Bienvenue à FusionAuth!<p>"
      },
      "localizedSubjects": {
        "de": "Hallo Welt",
        "fr": "Bonjour le monde"
      },
      "localizedTextTemplates": {
        "de": "Hallo ${user.username},\nWillkommen auf der FusionAuth!",
        "fr": "Bonjour ${user.username},\nBienvenue à FusionAuth!"
      },
      "name": "Hello World"
    }
  ]
}