Skip to content

List email templates

GET
/stores/{storeRef}/email-templates
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/email-templates \
--header 'x-api-key: <x-api-key>'

Returns every email template the store can customize, whether or not it has saved its own version: the sign-in and account emails, the order confirmation, shipped and delivered emails, and the review invitation. The list is not paginated.

Required scopes: read:settings

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
Array<object>
object
updated_at
required

When the store’s version was last saved, as an ISO 8601 timestamp. Null when the template has never been customized.

string
nullable
template_name
required

Template name, such as auth-reset-password. Use it as the name path parameter.

string
is_customized
required

Whether the store has saved its own version.

boolean
enabled
required

Whether the store’s version is used. Always true for a template that is not customized.

boolean

Example generated

[
{
"updated_at": "example",
"template_name": "example",
"is_customized": true,
"enabled": true
}
]

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}