Skip to main content
GET
List sends

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

emailId
string

Campaign grain: only sends of this design.

Required string length: 1 - 64
kind
enum<string>
Available options:
campaign,
automation
automationId
string
Required string length: 1 - 64
automationRunId
string
Required string length: 1 - 64
audienceRunId
string
Required string length: 1 - 64
triggerInstanceId
string
Required string length: 1 - 64
status
enum<string>
Available options:
scheduled,
queued,
running,
paused,
completed,
partially_completed,
failed,
canceled
messageClass
enum<string>
Available options:
marketing,
transactional
from
string<date-time>

Inclusive lower bound on updatedAt (ISO 8601).

to
string<date-time>

Inclusive upper bound on updatedAt (ISO 8601).

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 sends.

data
object[]
required
pagination
object
required