Skip to main content
GET
Get a send

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

sendId
string
required

Send id returned by POST /v1/sends.

Required string length: 1 - 64
Example:

"r4Kq8ZxL2mW7nT1vPb9Yc"

Query Parameters

include
string

Expansions: events attaches a bounded first page of the send’s analytics events.

Response

The send row.

sendId
string
required
Minimum string length: 1
kind
enum<string>
required
Available options:
campaign,
automation
emailId
string
required
Minimum string length: 1
status
enum<string>
required
Available options:
scheduled,
queued,
running,
paused,
completed,
partially_completed,
failed,
canceled
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
messageClass
enum<string>
Available options:
marketing,
transactional
automationId
string
Minimum string length: 1
nodeId
string
Minimum string length: 1
automationRunId
string
Minimum string length: 1
audienceRunId
string
Minimum string length: 1
triggerInstanceId
string
Minimum string length: 1
emailVersionId
string
Minimum string length: 1
approvalState
enum<string>
Available options:
pending,
approved,
rejected
subject
string
previewText
string
from
object
replyTo
string
domainId
string
audienceId
string
Minimum string length: 1
audienceName
string
Minimum string length: 1
recipientCount
integer
Required range: x >= 0
scheduledAt
string<date-time>
startedAt
string<date-time>
completedAt
string<date-time>
failedAt
string<date-time>
error
string
stats
object
delivery
object
gradualSend
object
events
object[]