Skip to main content
GET
Read email rendering progress

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

previewId
string
required
Required string length: 1 - 100

Response

Rendering progress for the pinned email version and requested clients.

previewId
string
required
emailId
string
required
status
enum<string>
required

The job: queued or running until every client settles, then completed, partially_completed (some screenshots failed) or failed.

Available options:
queued,
running,
completed,
partially_completed,
failed
previews
object[]
required
pending
string[]
required
createdAt
string<date-time>
required
expiresAt
string<date-time>
required
nextPollAfterMs
integer
required
Required range: x >= 0
credits
object
required
emailVersionId
string

Portable version ID when present. previewId pins the saved snapshot.