Get Email Template

GET

https://api.bigcommerce.com/stores/:store_hash/v3/marketing/email-templates/:template-name

GET

/stores/:store_hash/v3/marketing/email-templates/:template-name

curl https://api.bigcommerce.com/stores/store_hash/v3/marketing/email-templates/template-name \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

200Example

{
  "data": {
    "type_id": "account_reset_password_email",
    "body": "<!DOCTYPE html> <html lang=\"en\"> <head>     <meta charset=\"UTF-8\">     <title>Title</title> </head> <body> <p>     {{lang \"reset_password\" name=store.name}} </p> <br/> <br/> <a href=\"{{account.reset_password_link}}\">     {{account.reset_password_link}} </a>  </body> </html>",
    "translations": [
      {
        "locale": "en",
        "keys": {
          "reset_password": "To change your customer account password at {{name}} please click this link or copy and paste it into your browser:"
        }
      }
    ],
    "subject": "Reset your password at {{store.name}}"
  },
  "meta": {}
}

Get a single global email template or a channel-specific email template override.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Information & Settings	modify	`store_v2_information`
Information & Settings	read-only	`store_v2_information_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

template-namestringRequired

The name of the email template.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

channel_idintegerOptional

Channel ID to use for channel-specific settings. If omitted, you will interact with the global setting only.

Response

dataobjectOptional

Data for a particular email template

metaobjectOptional

Response metadata.