Skip to main content
GET
Get a flow

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Path Parameters

slug
string
required

The flow’s brand domain. A bare domain returns the brand’s primary flow; one send stream’s flow is ?kind= on it (or the path /v1/flows/{domain}/{kind}), as each GET /v1/flows row’s slug (<domain>/<kind>) names it. Case-insensitive.

Required string length: 1 - 253
Example:

"brew.new"

Query Parameters

kind
string

The flow's kind for a bare-domain slug, hyphenated: onboarding, trial, events, product-updates, promotions, optionally followed by -2, -3… for a brand's later flow of that kind.

Pattern: ^[a-z][a-z-]*[a-z](?:-[0-9]{1,3})?$
include
string

Detail-only expansions, comma-separated. html adds each step’s rendered HTML. Rendered email is bulky — over MCP only the first step or two fit one response; the rest arrive without html and the summary says how many were kept. A step’s emailId is already a valid referenceEmailId, so reuse needs no body; for the bodies themselves call GET /v1/flows/{slug}?include=html over REST, which has no cap. Best-effort per step: a step whose body is no longer servable comes back without html rather than failing the flow.

Response

The flow, with anchor and every step.

slug
string
required
Minimum string length: 1
brand
object
required
title
string
required
Minimum string length: 1
type
enum<string>
required
Available options:
newsletter,
signup
category
string
required
Minimum string length: 1
categoryLabel
string
required
Minimum string length: 1
emailCount
integer
required
Required range: x >= 1
spanDays
number
required
Required range: x >= 0
remixCount
integer
required
Required range: x >= 0
previewImages
string<uri>[]
required
publishedAt
string<date-time>
required
updatedAt
string<date-time>
required
kind
enum<string>
Available options:
onboarding,
trial,
events,
product_updates,
promotions
anchor
enum<string>
Available options:
submittedAt,
signedUpAt,
verifiedAt,
firstEmail
steps
object[]