Skip to main content
GET
Get a flow

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

flowId
string
required

The flow's internal id, e.g. clx9z8y7x6w5v4u3t2s1. Get it from List flows (the id field of each flow). It is NOT the publicId slug that appears in a flow's public URL: a slug answers 404 here. A flow your token cannot reach answers 404, indistinguishable from one that does not exist.

Response

The flow and what your token can do on it.

A flow and the access your token holds on it.

typebot
object
required

A flow with its full definition.

currentUserMode
enum<string>

What your token can do on the flow: write, read or guest.

Available options:
guest,
read,
write