Skip to main content
GET
List flows

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Query Parameters

slug
string

Fetch ONE flow by its brand domain (e.g. notion.com) → data: [flow] with every steps[] entry. Omit to LIST.

Required string length: 1 - 253
Pattern: ^[a-z0-9.-]+$
include
string

Detail-only expansions, comma-separated. html adds each step’s rendered HTML — up to 12 emails, so ask for it only when you will read them. Best-effort per step: a step whose body is no longer servable comes back without html instead of failing the flow.

brand
string

Exact brand domain filter for LIST, e.g. vercel.com.

Minimum string length: 1
category
enum<string>

Filter LIST by the flow’s dominant step category (welcome, newsletter, promotion, education, …).

Available options:
verification,
transactional,
direct_sales,
welcome,
promotion,
newsletter,
education,
abandoned_cart,
winback,
other
type
enum<string>

Filter LIST by how the sequence starts: signup (after creating an account) or newsletter (after subscribing).

Available options:
newsletter,
signup
semantic
string

Semantic search over what the sequences are about — “developer onboarding drip”, “trial expiry win-back”. Results come back in relevance order and sort is ignored.

Required string length: 1 - 500
sort
enum<string>

LIST order: newest (default), emails (longest sequences first), span (sequences that run the longest first), remixes (most remixed first).

Available options:
newest,
emails,
span,
remixes
limit
cursor
string
Required string length: 1 - 512

Response

A page of flow cards, or — with ?slug= — the one flow and its steps.

data
object[]
required
pagination
object