List flows

Lists public email flows, one brand’s real onboarding or newsletter sequence with the day each email landed, as cards under { data, pagination, total }. Organization-wide: the same bounded corpus the gallery shows (a few hundred flows), paged with limit/cursor.

Use when studying how real brands sequence email to plan or remix an automation, or finding the slug to read one flow in full.

Input brand (exact domain), category, type (signup | newsletter), sort (newest | emails | span | remixes), or semantic for relevance-ranked search (then sort is ignored).

Returns 200 with flow cards and total, the number of flows the query matches across every page (filters narrow it; semantic only orders it), so one limit=1 call counts them. isTotalExact is false when the read was cut at 500 flows (the newest, or the 500 nearest a semantic query; filters apply after it), and total is then a floor. A card never carries anchor or steps; every card carries the slug that getFlow takes. A flow holds at most 12 steps: capture keeps the first 12 and cuts the tail, so emailCount: 12 means twelve or more were sent.

Errors 400 INVALID_REQUEST for an unknown query key or value; 503 SERVICE_UNAVAILABLE when semantic search cannot run (no index, or its kill switch); retry without semantic.

See also getFlow, listTemplates.

GET /v1/flows

List flows

cURL

curl --request GET \
  --url https://brew.new/api/v1/flows \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "data": [
    {
      "slug": "brew.new",
      "brand": {
        "name": "Brew",
        "logo": "https://cdn.brew.new/brand/fetched-logo/brew.new/logo.png"
      },
      "title": "Brew onboarding flow",
      "type": "signup",
      "category": "welcome",
      "categoryLabel": "Welcome",
      "emailCount": 6,
      "spanDays": 14,
      "remixCount": 12,
      "previewImages": [
        "https://cdn.brew.new/email-preview-brew-1.png",
        "https://cdn.brew.new/email-preview-brew-2.png",
        "https://cdn.brew.new/email-preview-brew-3.png"
      ],
      "publishedAt": "2026-09-01T12:00:00.000Z",
      "updatedAt": "2026-09-01T12:00:00.000Z"
    }
  ],
  "pagination": {
    "limit": 100,
    "cursor": null,
    "hasMore": false
  },
  "total": 1,
  "isTotalExact": true
}

Authorizations

bearerAuthapiKeyAuth

Authorization · string · header · default: Bearer brew_your_api_key · required

Send your Brew API key as Authorization: Bearer brew_xxx.

Query Parameters

brand · string

Exact brand domain filter for LIST, e.g. brew.new.

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 · integer

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

Required range: 1 <= x <= 100

Example:

50

cursor · string

Required string length: 1 - 512

Response

200

application/json

A page of flow cards.

data · object[] · required

Show child attributes

pagination · object · required

Show child attributes

total · integer · required

Flows this query matches across every page (filters narrow, semantic only orders); a floor when isTotalExact is false.

Required range: x >= 0

isTotalExact · boolean · required

False when the read was cut at 500 flows (the newest, or the 500 nearest a semantic query), so total is a floor.