Skip to main content
GET
List a domain's unsubscribes

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

domainId
string
required

Domain id (opaque Convex document id) returned by POST /v1/domains and listed by GET /v1/domains.

Required string length: 1 - 64
Example:

"kx7bkh53hasmfeh5kd7sqgykt187g8ww"

Query Parameters

q
string

An address (anything with @) matches that address — exactly once complete, by prefix while partial. Other text is a word search over the address and the contact name.

Maximum string length: 320
scope
enum<string>

Which opt-outs to include: domain = this host’s list only, all = the brand-wide opt-out only, any (default) = either.

Available options:
any,
domain,
all
limit
integer

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

Required range: 1 <= x <= 100
cursor
string

Opaque pagination cursor echoed from the previous page’s pagination.cursor. Omit for the first page.

Required string length: 1 - 512

Response

A page of the domain’s unsubscribe list.

domainId
string
required
Required string length: 1 - 64
domainHost
string
required
data
object[]
required
pagination
object
required