---
title: "Get a product's onboarding flow"
method: GET
path: "/api/v1/flows/{productId}"
tags: ["flows"]
---

# Get a product's onboarding flow

`GET /api/v1/flows/{productId}`

## Request

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

Get the complete onboarding flow for a product: every step in order with titles, notes on
what happens, observed transitions (button labels and where they lead), and which steps are
alternate branches. Includes the handoff reference id to use with buildHandoff.

Use this to study how a competitor structures their signup and onboarding, what information
they collect at each step, and how they guide users to activation.

## Path parameters

- `productId` string, required

## Response `200`

The flow with all its steps.

- Flow
  - `productId` string
  - `productName` string
  - `flowTitle` string
  - `flowType` 'signup-onboarding' | 'search' | 'checkout' | 'booking' | 'marketplace'
  - `captured` string, date
  - `handoffId` string: Use with buildHandoff to get the full prompt.
  - `steps` FlowStep[]
    - `id` string
    - `title` string
    - `notes` string
    - `imageUrl` string
    - `previewUrl` string
    - `branch` boolean: True if this step is an alternate path
    - `transitions` object[]
      - `action` string: The button or link text.
      - `to` string: Where this action leads.

## Other responses

- `404`: No product, screen or reference with that id.

---

[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)