---
title: "List captured onboarding flows"
method: GET
path: "/api/v1/flows"
tags: ["flows"]
---

# List captured onboarding flows

`GET /api/v1/flows`

## Request

- Base URL: `https://screenrove.com`
- URL: `https://screenrove.com/api/v1/flows`
- Auth: none declared

List every captured user journey: onboarding flows, signup sequences, checkout processes,
booking flows, and marketplace explorations. Shows step counts, flow type, and observed
transitions between steps.

Use this to find complete user journey references—not just individual screens—so you can
see how products guide users through multi-step processes like signup, onboarding, or checkout.

## Query parameters

- `flowType` 'signup-onboarding' | 'search' | 'checkout' | 'booking' | 'marketplace'

## Response `200`

Flows with their step summaries.

- FlowList
  - `total` integer
  - `flows` FlowSummary[]
    - `productId` string
    - `productName` string
    - `flowTitle` string: Human-readable title for the flow
    - `flowType` 'signup-onboarding' | 'search' | 'checkout' | 'booking' | 'marketplace': What the flow accomplishes.
    - `stepCount` integer: Total steps including branches.
    - `branchCount` integer: Steps that are alternate branches (not the main path).
    - `handoffId` string: Use with buildHandoff

---

[API](https://skmtc.dev/screenrove/apis/screenrove-api.md) · [All operations](https://skmtc.dev/screenrove/apis/screenrove-api/llms.txt) · [OpenAPI document](https://skmtc.dev/screenrove/apis/screenrove-api/revisions/9383a872c966?raw)