Get a transactional email

curl --request GET \
  --url https://brew.new/api/v1/transactional/{transactionId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://brew.new/api/v1/transactional/{transactionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://brew.new/api/v1/transactional/{transactionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://brew.new/api/v1/transactional/{transactionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/transactional/{transactionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "transactionId": "txn_8fK2mQ4pLx",
  "emailId": "eml_receipt",
  "emailVersionId": "emv_receipt_v2",
  "domainId": "kx7bkh53hasmfeh5kd7sqgykt187g8ww",
  "subject": "Your receipt from Acme",
  "previewText": "Order #1234",
  "createdAt": "2026-08-18T12:00:00.000Z",
  "updatedAt": "2026-08-18T12:00:00.000Z",
  "variables": [
    {
      "name": "orderId",
      "type": "string",
      "fallback": null
    },
    {
      "name": "firstName",
      "type": "string",
      "fallback": "there"
    }
  ],
  "templating": {
    "engine": "liquid",
    "valid": true,
    "errors": []
  },
  "variableTree": [
    {
      "key": "order",
      "path": "trigger.order",
      "kind": "object",
      "fallback": null,
      "namespace": "trigger",
      "children": [
        {
          "key": "total",
          "path": "trigger.order.total",
          "kind": "scalar",
          "fallback": null,
          "namespace": "trigger",
          "children": []
        }
      ]
    }
  ],
  "examplePayload": {
    "order": {
      "total": "example_total"
    }
  }
}

{
  "error": {
    "code": "INVALID_API_KEY",
    "type": "authentication_error",
    "message": "The provided API key is invalid.",
    "suggestion": "Check the API key format and retry with a valid active key.",
    "docs": "https://docs.brew.new/api-reference/api/authentication"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "type": "authorization_error",
    "message": "The caller does not have the required permission.",
    "suggestion": "Use an API key or session with the required permission.",
    "docs": "https://docs.brew.new/api-reference/api/authentication",
    "param": "sends"
  }
}

{
  "error": {
    "code": "TRANSACTIONAL_EMAIL_NOT_FOUND",
    "type": "not_found",
    "message": "No transactional email was found with id 'txn_xxx'.",
    "suggestion": "Create one from Email Actions → Transactional Email, then fire it with POST /v1/sends { transactionId, to }.",
    "docs": "https://docs.brew.new/api-reference/api/errors",
    "param": "transactionId"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "type": "rate_limit",
    "message": "Too many requests.",
    "suggestion": "Wait for the retry window before sending another request.",
    "docs": "https://docs.brew.new/api-reference/api/rate-limits",
    "retryAfter": 42
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "type": "internal_error",
    "message": "An unexpected error occurred.",
    "suggestion": "Retry the request. If it keeps failing, contact support.",
    "docs": "https://docs.brew.new/api-reference/api/errors"
  }
}

Emails

Get a transactional email

Read a reusable transactional email object: locked domainId / emailId / emailVersionId, envelope defaults, and the merge-tag list for snippets. On Liquid-enabled workspaces the response also carries the payload contract — variableTree (every trigger.* / customer.* path the pinned template references, with array/object shape and fallbacks), examplePayload (a nested payload that fires verbatim), and templating (engine + parse validity). Recomputed from the pinned design on every read. Fire it with POST /v1/sends { transactionId, to, payload? }. Permission: sends. There is no messageClass on this object — purpose lives on the sending domain.

GET

transactional

{transactionId}

curl --request GET \
  --url https://brew.new/api/v1/transactional/{transactionId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://brew.new/api/v1/transactional/{transactionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://brew.new/api/v1/transactional/{transactionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://brew.new/api/v1/transactional/{transactionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/transactional/{transactionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "transactionId": "txn_8fK2mQ4pLx",
  "emailId": "eml_receipt",
  "emailVersionId": "emv_receipt_v2",
  "domainId": "kx7bkh53hasmfeh5kd7sqgykt187g8ww",
  "subject": "Your receipt from Acme",
  "previewText": "Order #1234",
  "createdAt": "2026-08-18T12:00:00.000Z",
  "updatedAt": "2026-08-18T12:00:00.000Z",
  "variables": [
    {
      "name": "orderId",
      "type": "string",
      "fallback": null
    },
    {
      "name": "firstName",
      "type": "string",
      "fallback": "there"
    }
  ],
  "templating": {
    "engine": "liquid",
    "valid": true,
    "errors": []
  },
  "variableTree": [
    {
      "key": "order",
      "path": "trigger.order",
      "kind": "object",
      "fallback": null,
      "namespace": "trigger",
      "children": [
        {
          "key": "total",
          "path": "trigger.order.total",
          "kind": "scalar",
          "fallback": null,
          "namespace": "trigger",
          "children": []
        }
      ]
    }
  ],
  "examplePayload": {
    "order": {
      "total": "example_total"
    }
  }
}

{
  "error": {
    "code": "INVALID_API_KEY",
    "type": "authentication_error",
    "message": "The provided API key is invalid.",
    "suggestion": "Check the API key format and retry with a valid active key.",
    "docs": "https://docs.brew.new/api-reference/api/authentication"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "type": "authorization_error",
    "message": "The caller does not have the required permission.",
    "suggestion": "Use an API key or session with the required permission.",
    "docs": "https://docs.brew.new/api-reference/api/authentication",
    "param": "sends"
  }
}

{
  "error": {
    "code": "TRANSACTIONAL_EMAIL_NOT_FOUND",
    "type": "not_found",
    "message": "No transactional email was found with id 'txn_xxx'.",
    "suggestion": "Create one from Email Actions → Transactional Email, then fire it with POST /v1/sends { transactionId, to }.",
    "docs": "https://docs.brew.new/api-reference/api/errors",
    "param": "transactionId"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "type": "rate_limit",
    "message": "Too many requests.",
    "suggestion": "Wait for the retry window before sending another request.",
    "docs": "https://docs.brew.new/api-reference/api/rate-limits",
    "retryAfter": 42
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "type": "internal_error",
    "message": "An unexpected error occurred.",
    "suggestion": "Retry the request. If it keeps failing, contact support.",
    "docs": "https://docs.brew.new/api-reference/api/errors"
  }
}

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"

Query Parameters

include

enum<string>

Pass skill to add a skill field to the response: a complete SKILL.md-shaped wiring brief (endpoint, auth, typed payload contract, copy-paste snippets) for a coding agent or your repo.

Available options:

skill

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

Show child attributes

replyTo

string

senderName

string

fromEmail

string

previewText

string

templating

object

Show child attributes

variableTree

object[]

Show child attributes

examplePayload

object

Show child attributes

skill

string

⌘I

Get started

Overview

Core concepts

Guides

MCP server

CLI

Public API v1

Get a transactional email

Authorizations

Headers

Path Parameters

Query Parameters

Response