Skip to main content
GET
List email groups

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

groupId
string

Named group id (grp_…), or ungrouped on reads. Writes reject Ungrouped sentinels.

Required string length: 1 - 64
limit
cursor
string
Required string length: 1 - 512

Response

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

data
object[]
required
pagination
object