Skip to main content
GET
List flows

Authorizations

Authorization
string
header
required

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

Query Parameters

workspaceId
string
required

The workspace to read, e.g. clx1a2b3c4d5e6f7g8h9. Get it from List workspaces, which lists every workspace your token reaches. A workspace your token cannot reach answers 404, indistinguishable from one that does not exist.

folderId
string

Only the flows inside this folder, by folder id. Pass root for the flows that sit outside any folder. Omit to list flows from every folder. Workspace guests always see only the flows shared with them, whatever this says.

Keep only the flows whose name contains this text, ignoring case.

status
string

Keep only flows in this state, as a comma-separated list: active (has a published version) and/or inactive (draft only). Omit for both.

type
enum<string>

Keep only flows of this type. TOOL lists the tools agents can call; default the ordinary flows. Omit for every type.

Available options:
default,
TOOL,
CONTEXT_ENRICHMENT
excludeTools
boolean

When true, leaves out the TOOL and CONTEXT_ENRICHMENT flows and returns only ordinary ones. Prefer type when you know which type you want.

createdAtFrom
string<date-time>

Keep only flows created at or after this instant, as an ISO 8601 UTC timestamp. Must not be later than createdAtTo.

createdAtTo
string<date-time>

Keep only flows created at or before this instant, as an ISO 8601 UTC timestamp. Must not be earlier than createdAtFrom.

Response

The matching flows, newest first. An empty list means the workspace has none that match.

The flows of a workspace that match the filters.

typebots
object[]
required

The flows that match, newest first.