Skip to main content
POST
List Flow Plan Enrollments

Authorizations

X-API-Key
string
header
required

Body

application/json
flowPlanId
string | null
required

Existing flow plan id. Use the exact flowPlanId returned by create_flow_plan, list_flow_plans, get_flow_workspace, or add_dynamic_action.

status
enum<string>
default:in_progress

Flow-plan enrollment page status bucket to list.

Available options:
in_progress,
failed,
completed,
canceled,
disqualified
limit
integer
default:10

Max enrollment rows to return. Prefer the default 10; set 25 only when the customer asks for a larger page.

cursor
string | null

Offset cursor returned by a previous list_flow_plan_enrollments call.

Response

Tool result.