Skip to main content
POST
Get Flow Enrollment

Authorizations

X-API-Key
string
header
required

Body

application/json
enrollmentId
string | null
required

Enrollment/activity id. From enrollment list tools, use exact enrollmentId only when canInspectEnrollment is true; queue rows do not have an enrollment yet. Do not pass queueItemId here.

includeProperties
boolean
default:false

When true, include raw enrollment.properties: prospect and company fields, current owner and channel-specific assignee user ids, selected email account id, source description, and custom or enriched flow values.

  • These are enrollment-level values and may not identify a historical action's per-action override.
  • Defaults to false because enriched profiles can make the response too large for MCP clients.
includeFlowTree
boolean
default:false

When true, include flowTree: the root/tree stored on this enrollment when it was created. Defaults to false because trees can be large. This enrollment snapshot can differ from the current flow-plan root if the plan was edited later.

Response

Tool result.