Workflows
Workflows (also known as Flows) are powerful automation tools that trigger actions based on events and conditions. They enable sophisticated marketing automation including welcome series, abandoned cart recovery, re-engagement campaigns, and complex multi-branch journeys. The Workflows API allows you to retrieve and manage your automation workflows programmatically.
Available Endpoints
The Workflow Model
The workflow model represents an automation flow with its associated email templates and performance statistics.
Properties
- Name
id- Type
- string
- Description
The unique identifier for the workflow
- Name
name- Type
- string
- Description
The name of the workflow
- Name
created_at- Type
- datetime
- Description
When the workflow was created
- Name
email_templates- Type
- array
- Description
Array of email templates used in this workflow, each with id, subject, and stats
Get Workflows
Returns a list of all workflows in your account, including their associated email templates and performance statistics.
Query Parameters
- Name
site_uuid- Type
- string
- Description
Your site's unique identifier
- Name
page- Type
- integer
- Description
Page number for pagination (optional)
Response
Returns a list of workflows with their email templates and stats.
