Skip to main content
GET
Get an automation run

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

automationRunId
string
required
Required string length: 1 - 64

Query Parameters

include
string

Expansions: logs inlines the newest 100 per-node execution logs and reports logsTruncated.

Response

The run row.

automationRunId
string
required
Required string length: 1 - 64
automationId
string
required
Required string length: 1 - 64
mode
enum<string>
required
Available options:
live,
test
status
enum<string>
required
Available options:
queued,
running,
completed,
failed,
canceled
automationVersionId
string
Required string length: 1 - 64
definitionHash
string
Required string length: 64
triggerInstanceId
string
Required string length: 4 - 64
recipientEmail
string
startedAt
string<date-time>
completedAt
string<date-time>
error
string
logs
object[]
logsTruncated
boolean