Skip to main content
GET
List email comments

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

emailId
string
required

Design id returned by POST /v1/emails and listed by GET /v1/emails.

Required string length: 1 - 64
Example:

"2SmZOWV3ZQ7W5x6g3m4pA"

Query Parameters

include
string

Comma-separated expansions: messages adds each thread's newest messages (author, body, mentions), oldest first, with a messagesCursor for older ones, and caps the page at 3 threads.

commentId
string

Read this one thread (cmt_…) instead of the page; not with cursor.

Required string length: 5 - 64
messagesCursor
string

A thread's messagesCursor from a previous response, with that thread's commentId: returns the thread with its next older messages and the next messagesCursor. Implies include=messages.

Required string length: 1 - 512
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 the design's open comment threads.

data
object[]
required
pagination
object
required