Skip to main content
GET
List email designs

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

Only designs whose title contains this text (case-insensitive), or whose title, subject line, preview or visible text matches its words (full-text over each design’s first 16,384 characters; the other filters apply to the 1,024 best matches).

Required string length: 1 - 200
status
enum<string>

Only designs in this status (generating, ready, failed).

Available options:
generating,
ready,
failed
groupId
string

Only designs in one group (grp_…, or ungrouped).

Required string length: 1 - 64
sortBy
enum<string>
default:updatedAt

The timestamp the page is ordered by, newest first, and that from/to bound. Defaults to updatedAt.

Available options:
updatedAt,
createdAt
from
string<date-time>

Inclusive lower bound on the sortBy timestamp (ISO 8601).

to
string<date-time>

Inclusive upper bound on the sortBy timestamp (ISO 8601).

limit
integer

Page size (1-100). Defaults to 100.

Required range: 1 <= x <= 100
Example:

50

cursor
string
Required string length: 1 - 512

Response

A page of email designs.

data
object[]
required
pagination
object
required