Skip to main content
POST
List Flow Plans

Authorizations

X-API-Key
string
header
required

Body

application/json
limit
integer | null

Max flow plans to return. Defaults to 10 and is capped at 25. For top/most/highest flow questions, use 5 unless the customer asks for more.

cursor
string | null

Cursor from a previous list_flow_plans response.

isDraft
boolean | null

Filter by draft state. true returns drafts, false returns published flows, omit for both.

name
string | null

Exact flow plan name filter.

searchQuery
string | null

Search flow plans by name.

sourceless
boolean | null

Filter to flows without a linked source.

flowPlanIds
(string | null)[] | null

Optional flow plan ids to return. Use exact flowPlanId values returned by create_flow_plan, list_flow_plans, get_flow_workspace, or add_dynamic_action.

audienceSources
enum<string>[] | null

Optional audience source filters for linked audience flows, for example manual, hubspot, or sales_navigator.

Available options:
hubspot,
csv,
manual,
system,
sales_navigator
includeMetrics
boolean
default:false

Include metric values in each row. Adds an extra metrics query; keep false for lightweight discovery unless the customer asks for metric values.

includeCost
boolean
default:false

Include estimated single-enrollment cost in each row. This calculates cost per returned flow; keep false unless the customer asks about cost or credits.

orderBy
enum<string> | null

Sort key: created, name, enrollments, replies, opportunities, or awaiting. Defaults to created.

Available options:
created,
enrollments,
replies,
opportunities,
name,
awaiting,
null
orderDirection
enum<string> | null

Sort direction: ascending or descending. Defaults to descending.

Available options:
ascending,
descending,
null

Response

Tool result.