Skip to main content
GET
List automation runs

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

automationId
string
Required string length: 1 - 64
triggerEventId
string
Required string length: 1 - 256
triggerInstanceId
string
Required string length: 4 - 64
recipientEmail
string<email>

Only runs for this recipient, matched case-insensitively against each run's stored recipientEmail column. A run written before that column existed carries the address only inside its trigger payload: the row still REPORTS recipientEmail (the projection reads the payload as a fallback), but the filter cannot reach it until migration_mutations:backfillRecipientEmail has run on the deployment.

status
enum<string>
Available options:
queued,
running,
completed,
failed,
canceled
mode
enum<string>
Available options:
live,
test
from
string<date-time>
to
string<date-time>
limit
integer

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

Required range: 1 <= x <= 100
cursor
string
Required string length: 1 - 8192

Response

A page of runs.

data
object[]
required
pagination
object
required