Skip to main content
GET
Get a transactional email

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Path Parameters

transactionId
string
required

Public transactional email id (txn_…) returned when the object is created.

Required string length: 1 - 128
Example:

"txn_8fK2mQ4pLx"

Response

The transactional email object.

transactionId
string
required
Minimum string length: 1
emailId
string
required
Minimum string length: 1
emailVersionId
string
required
Minimum string length: 1
domainId
string
required
Minimum string length: 1
subject
string
required
Minimum string length: 1
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
variables
object[]
required
replyTo
string
senderName
string
fromEmail
string
previewText
string
templating
object
variableTree
object[]
examplePayload
object