Skip to main content
POST
Get Flow Available Variables

Authorizations

X-API-Key
string
header
required

Body

application/json
source
string
default:ft

Variable source: ft for flow properties or hs for connected CRM properties. Common CRM source aliases are normalized to hs.

objectName
string | null

Variable object/group name. For ft, omit or use flow for flow variables, or use custom for enrollment inputs. For hs, omit for contact properties or specify a connected CRM object group.

flowPlanId
string | null

Optional flow plan id. Used with nodeId to include custom variables produced by earlier AI research nodes. Use the exact flowPlanId returned by create_flow_plan, list_flow_plans, or get_flow_workspace.

nodeId
string | null

Optional node id. Example: node_email_1. Use an id from the submitted root tree or get_flow_workspace.flowPlan.root; when provided, the response includes custom variables available before this node.

root
any | null

Optional root tree to evaluate custom variables against instead of the persisted flow root.

customVariables
(object | null)[] | null

Proposed custom definitions for a new flow. Used only with source=ft and objectName=custom; existing flow definitions are loaded through flowPlanId.

searchQuery
string | null

Optional case-insensitive search in variable names and labels. Apply before pagination.

cursor
string | null

Next page cursor returned by this tool. Keep the same source, objectName, and searchQuery.

Response

Tool result.