Skip to content

List Workflows

Lists all workflows (flows) for the brand. Returns workflow IDs, names, types, and status.

NameTypeRequiredDescriptionDefault
statusstringNoFilter by status: active, draftAll
includeHistoricalbooleanNoInclude historical lookback flowsfalse
  • checkout — Abandoned cart recovery
  • order — Post-purchase flows
  • cart — Cart-based flows
  • schedule — Scheduled campaigns
  • tap_to_text — Tap-to-text opt-in flows
  • events — Event/campaign-triggered flows
  • historical — Historical lookback flows
Which workflows are currently active?
{
"workflows": [
{
"id": "wf-001",
"name": "Abandoned Cart - Main",
"type": "checkout",
"isPaused": false,
"status": "active"
},
{
"id": "wf-002",
"name": "Post Purchase Upsell",
"type": "order",
"isPaused": true,
"status": "active"
}
],
"totalCount": 2
}
  • Workflow IDs from this tool are needed for get_workflow_details and for filtering dashboard-stats and list_conversations
  • A workflow can have status: "active" but isPaused: true — this means it’s configured but temporarily paused
  • Use includeHistorical: true to see historical lookback flows (excluded by default)