Skip to main content
GET
Get email 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

sendId
string

Fetch a single send by id (detail mode → { data: [row] }). Omit to list.

Required string length: 1 - 64
emailId
string

List mode — narrow to one design’s sends. Mutually exclusive with sendId.

Required string length: 1 - 64
include
enum<string>

Detail-only expansion: events inlines a bounded first page of the send’s analytics events. Rejected without sendId.

Available options:
events
status
enum<string>
Available options:
scheduled,
queued,
sending,
paused,
sent,
partially_sent,
failed,
canceled
from
string<date-time>
to
string<date-time>
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 sends (list mode), or { data: [row] } (detail mode; events[] present when ?include=events).

data
object[]
required
pagination
object