v1

latestSwagger 2.0Private2026-08-04128286690.5 KB

Automations

List All Automations

Use this method to list all available automation workflows.

get/automations/workflows

Query parameters

channelstring

Filter by channel

sort_direction'ASC' | 'DESC'

Sort direction, ASC or DESC. Defaults to DESC

created_from'SCRATCH' | 'TEMPLATE'

Filter by how the workflow was created

goalsstring

Filter by goal tags (e.g. post_purchase_followup, up_sell_and_cross_sell)

namestring

Find by workflow name (exact match)

Response

Request successful

Example response

{
  "flow_summaries": [
    {
      "active_state": "ACTIVE",
      "created_by_id": "123456789",
      "created_date": "2025-09-25T20:06:50.020+00:00",
      "description": "Automation flow for contact signups",
      "draft_state": "PROMOTED",
      "id": "83345850-144a-4dcf-b4dc-88aa1287cffe",
      "name": "Welcome series",
      "promoted_by_id": "123456789",
      "promoted_date": "2025-09-25T20:06:50.970+00:00",
      "status": "ACTIVE",
      "structured_tags": [
        {
          "display_value": "All from-scratch paths",
          "key": "GOAL",
          "value": "goal_undefined"
        }
      ],
      "template_id": "17f58023-559a-41e5-84b7-0e9e213f7aef",
      "update_date": "2025-09-25T20:06:50.970+00:00"
    }
  ]
}