API/List Email Workflows API

List Email Workflows API

List API-triggerable email workflows for the active organization.

List workflows whose trigger is set to API request. Use this endpoint to find the workflowId accepted by POST /api/v1/email/workflows/trigger.

Request

GET /api/v1/email/workflows

Query parameters:

ParameterTypeDescription
statusstringOptional draft, active, or paused filter.
curl -H "x-api-key: org_api_key" \
  "https://growth.example.com/api/v1/email/workflows?status=active"

Response

{
  "workflows": [
    {
      "id": "m57...",
      "name": "Lead magnet delivery",
      "trigger": "api_request",
      "status": "active",
      "steps": [],
      "createdAt": 1783528574709,
      "updatedAt": 1783528574709
    }
  ],
  "sampleLimited": false
}

Error responses:

StatusMeaning
400Invalid status filter.
401Missing or invalid API key.

Notes

  • Only API-request workflows are returned.
  • A workflow must be active before it can be triggered.