Receive a single automated flow

One automated flow with its full structure: every item with its content and outbound edges resolved to item ids — entryFlowItemId is the first item; nextItemId: null means end of branch. The id of a campaign-backed flow returns 404 — use /campaign-flows/{id} instead.

get

Authorizations

X-Recart-API-KeystringRequired

It can be obtained in Recart account after contacting Support

Path parameters

idstringRequired

ID of the automated flow

Responses

200

Ok

application/vnd.api+json

4XX

HTTP Error response

application/vnd.api+json

5XX

HTTP Error response

application/vnd.api+json

get/automated-flows/{id}

GET /app-integrations/2023-12/automated-flows/{id} HTTP/1.1
Host: api.recart.com
X-Recart-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": {
    "type": "automated-flows",
    "attributes": {
      "id": "655637c97825e6ae655fe1b5",
      "name": "Welcome flow",
      "status": "active",
      "tags": [
        "default-welcome",
        "automated"
      ],
      "isQuietHoursEnabled": true,
      "isSmartSendingEnabled": false,
      "createdAt": "2026-01-10T09:00:00.000Z",
      "updatedAt": "2026-08-20T09:00:00.000Z",
      "entryFlowItemId": "655637c97825e6ae655fe401",
      "items": [
        {
          "type": "flow-item",
          "attributes": {
            "type": "sms",
            "id": "655637c97825e6ae655fe401",
            "name": "Welcome message",
            "messages": [
              {
                "text": "Welcome to our SMS list! Reply STOP to opt out.",
                "imageUrl": null
              }
            ],
            "nextItemId": "655637c97825e6ae655fe402"
          }
        },
        {
          "type": "flow-item",
          "attributes": {
            "type": "delay",
            "id": "655637c97825e6ae655fe402",
            "delayType": "delay",
            "durationInSeconds": 86400,
            "nextItemId": "655637c97825e6ae655fe403"
          }
        },
        {
          "type": "flow-item",
          "attributes": {
            "type": "conditional-split",
            "id": "655637c97825e6ae655fe403",
            "branches": [
              {
                "expression": {
                  "any": [
                    {
                      "fact": "hasPurchased",
                      "operator": "equal",
                      "value": true
                    }
                  ]
                },
                "nextItemId": "655637c97825e6ae655fe404"
              }
            ],
            "defaultNextItemId": null
          }
        },
        {
          "type": "flow-item",
          "attributes": {
            "type": "sms",
            "id": "655637c97825e6ae655fe404",
            "name": "Follow-up message",
            "messages": [
              {
                "text": "Thanks for joining! Here is 10% off your first order.",
                "imageUrl": null
              }
            ],
            "nextItemId": null
          }
        }
      ]
    }
  }
}