BRbrew
Emails

Get emails

Unified email-design read. Omit emailId to LIST the brand’s designs (newest first) under { data, pagination } — each row carries emailId, the latest emailVersionId, title, status, previewImage (when captured), and updatedAt. Filter with ?status= and the createdAtFrom/To + updatedAtFrom/To ISO-8601 windows; paginate with limit + cursor. Pass ?emailId= to fetch ONE design — returns { data: [row] } (no pagination), 404 EMAIL_NOT_FOUND on an unknown / cross-brand id. Add detail-only ?include=html (rendered HTML) and/or ?include=versions (lean { version, emailVersionId } history) — both rejected without emailId.

get/v1/emails

Request

Query parameters

emailIdstring
includestring
status'streaming' | 'complete' | 'error'
createdAtFromstring date-time
createdAtTostring date-time
updatedAtFromstring date-time
updatedAtTostring date-time
number
OR
string
cursorstring

Response

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

Changes

No recorded changes to this operation across all 1 revision of this API.