> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# emailTemplates
> List email templates, optionally filtered by name or trigger.
**Required scopes:** [`marketing_templates_read`](/docs/api-reference/v3/reference/scopes#scope-marketing_templates_read)
## Arguments
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
EmailTemplateSortKey}>
Which key to sort by (defaults to the first key, newest-first). Combine with `reverse` to flip direction.
Case-insensitive substring match on the template name. At most 200 characters.
Reverses the sort direction selected by `orderBy` (or its default).
MarketingTrigger}>
Only include templates for this trigger.
## Returns
EmailTemplateConnection!} required>
A paginated list of EmailTemplate items.
[EmailTemplateEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
EmailTemplate!} required>
The item at this edge.
The content canvas background, as set under Email styles in the email builder.
DateTime!} required>
When the template was created.
The email background, as set under Email styles in the email builder.
The id of this template.
The template's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
The default link color, as set under Email styles in the email builder. Null when the merchant left it unset.
The merchant-facing name of the template.
EmailTemplatePreview}>
Render this template, to see what recipients get. Use a width of about 375 for a phone.
**Requires:** [`marketing_templates_read`](/docs/api-reference/v3/reference/scopes#scope-marketing_templates_read)
**Arguments**
Render with this recent event's data instead of sample data: a 24-character hex event id. A well-formed id that can't be found falls back to sample data.
Viewport width of the screenshot, 320-1200 pixels.
The preview text shown after the subject in an inbox. Null when the merchant left it unset.
[EmailTemplateSection!]!} required>
The blocks that make up the email body, in order. Nested column children keep their own ids. A type this API version does not model field-by-field is returned as EmailTemplateUnknownSection.
[JSON!]!} required>
`sections` with every field selected, as JSON: one element per root block, in order, with `__typename` and nested column children. Empty or unreadable stored sections are \[]. Edits go through operations.
The subject line **as authored**, before per-recipient substitution. A subject containing `{{ }}` placeholders is filled in per customer at send time, and some sends prepend a prefix, so this is not necessarily the subject any one customer saw. Empty when the template has no subject of its own.
MarketingTrigger!} required>
The trigger context this template is valid for. Immutable after create. UNKNOWN when the stored trigger is not modeled in this API version.
DateTime!} required>
When the template was last edited. Templates stay editable after the campaigns that used them have finished, so compare this against a campaign's `finishedAt` to tell whether the content here is still what that campaign actually sent.
[EmailTemplate!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
The content canvas background, as set under Email styles in the email builder.
DateTime!} required>
When the template was created.
The email background, as set under Email styles in the email builder.
The id of this template.
The template's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
The default link color, as set under Email styles in the email builder. Null when the merchant left it unset.
The merchant-facing name of the template.
EmailTemplatePreview}>
Render this template, to see what recipients get. Use a width of about 375 for a phone.
**Requires:** [`marketing_templates_read`](/docs/api-reference/v3/reference/scopes#scope-marketing_templates_read)
**Arguments**
Render with this recent event's data instead of sample data: a 24-character hex event id. A well-formed id that can't be found falls back to sample data.
Viewport width of the screenshot, 320-1200 pixels.
**Fields**
The screenshot's full height in pixels.
The rendered email HTML, as a recipient's client would receive it.
A link to a full-length PNG screenshot at the requested width. It expires after an hour.
The screenshot's width in pixels.
The preview text shown after the subject in an inbox. Null when the merchant left it unset.
[EmailTemplateSection!]!} required>
The blocks that make up the email body, in order. Nested column children keep their own ids. A type this API version does not model field-by-field is returned as EmailTemplateUnknownSection.
[JSON!]!} required>
`sections` with every field selected, as JSON: one element per root block, in order, with `__typename` and nested column children. Empty or unreadable stored sections are \[]. Edits go through operations.
The subject line **as authored**, before per-recipient substitution. A subject containing `{{ }}` placeholders is filled in per customer at send time, and some sends prepend a prefix, so this is not necessarily the subject any one customer saw. Empty when the template has no subject of its own.
MarketingTrigger!} required>
The trigger context this template is valid for. Immutable after create. UNKNOWN when the stored trigger is not modeled in this API version.
DateTime!} required>
When the template was last edited. Templates stay editable after the campaigns that used them have finished, so compare this against a campaign's `finishedAt` to tell whether the content here is still what that campaign actually sent.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
## Example
```graphql theme={null}
query {
emailTemplates(after: "...", before: "...", first: 10, last: 10, orderBy: CREATED_AT, query: "...", reverse: true, trigger: ADDRESS_VERIFICATION_FAILED) {
nodes {
contentBackgroundColor
createdAt
emailBackgroundColor
id
legacyId
linkColor
name
previewText
# ...
}
pageInfo { hasNextPage endCursor }
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.