Skip to main content
GET
Get emails

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

Query Parameters

emailId
string
Required string length: 1 - 64
include
string
status
enum<string>
Available options:
streaming,
complete,
error
createdAtFrom
string<date-time>
createdAtTo
string<date-time>
updatedAtFrom
string<date-time>
updatedAtTo
string<date-time>
limit
cursor
string
Required string length: 1 - 512

Response

A page of email designs (list mode), or { data: [row] } (detail mode).

data
object[]
required
pagination
object