Skip to main content
GET
List notifications

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

type
enum<string>

Only notifications of this type. A type this credential cannot see (its scopes, or a person-only or admin-only type) is an empty page.

Available options:
chat_stream,
import_job,
brand_image_import,
validation_job,
email_sent,
email_scheduled,
preview_email,
brand_extracted,
domain_status,
domain_score_run,
api_key_created,
email_send_failed,
gradual_send_paused,
gradual_send_completed,
send_limit_reached,
automation_pause_window_closed,
send_review_rejected,
comment_mention,
comment_reply
limit
integer

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

Required range: 1 <= x <= 100
Example:

50

cursor
string
Required string length: 1 - 8192

Response

A page of notifications.

data
object[]
required
pagination
object
required