Get a Single Flow

curl --request GET \
  --url https://api-{dc}.moengage.com/v5/flows/{flow_id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "response_id": "abc-100",
  "type": "flow",
  "data": {
    "flow_id": "69f1de84f9e401a2d7d9a931",
    "name": "Welcome journey",
    "status": "ACTIVE",
    "archived": false,
    "delivery_type": "EVENT_TRIGGERED",
    "tags": [
      "onboarding"
    ],
    "created_at": "2026-01-05T10:00:00Z",
    "updated_at": "2026-02-01T09:30:00Z",
    "published_at": "2026-01-06T08:00:00Z",
    "created_by": "[email protected]",
    "published_by": "[email protected]",
    "global_control_group_enabled": false,
    "active_version_name": "Version 2",
    "versions": [
      {
        "version_id": "69f1de84f9e401a2d7d9a931",
        "version_name": "Version 1",
        "version_no": 1,
        "status": "RETIRED"
      },
      {
        "version_id": "7a02ef95f9e401a2d7d9aa42",
        "version_name": "Version 2",
        "version_no": 2,
        "status": "ACTIVE"
      }
    ],
    "settings": {
      "control_group": {
        "enabled": false
      },
      "frequency_capping": {
        "ignore": false,
        "ignore_and_count": false
      },
      "bypass_dnd": false
    },
    "attribution": {
      "click_track_hours": 24,
      "impression_track_hours": 24
    },
    "conversion_goal_details": {
      "primary_goal": {
        "event": "Purchase",
        "goal_name": "Made a purchase"
      },
      "secondary_goals": [],
      "revenue_tracking": true,
      "revenue_attribute": "amount",
      "revenue_currency": "USD",
      "exit_on_conversion": false
    },
    "structure": {
      "nodes": [
        {
          "stage_id": "n1",
          "type": "TRIGGER",
          "sub_type": "EVENT",
          "parent_stage_id": null,
          "child_stage_ids": [
            "n2"
          ],
          "label": "App Opened",
          "config": {
            "schedule": {
              "delivery": "one_time",
              "start_time": "2026-01-06T08:00:00Z",
              "timezone": "Asia/Kolkata"
            },
            "segmentation": {
              "audience_type": "all_users"
            }
          }
        },
        {
          "stage_id": "n2",
          "type": "ACTION",
          "sub_type": "EMAIL",
          "parent_stage_id": "n1",
          "child_stage_ids": [],
          "label": "Welcome email",
          "config": {
            "campaign_id": "69f1de84f9e401a2d7d9a999",
            "channel": "EMAIL",
            "campaign_name": "Welcome email"
          }
        }
      ]
    }
  }
}

{
  "response_id": "abc-101",
  "error": {
    "code": "VALIDATION_FAILED",
    "target": "request",
    "message": "One or more request parameters failed validation.",
    "details": [
      {
        "target": "request",
        "message": "Check the request parameters and try again."
      }
    ]
  }
}

{
  "response_id": "abc-101",
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing credentials.",
    "details": []
  }
}

{
  "response_id": "abc-450",
  "error": {
    "code": "FORBIDDEN",
    "target": "permission",
    "message": "You do not have the required permission for this operation.",
    "details": [
      {
        "target": "permission",
        "message": "Required permission: campaigns:view"
      }
    ]
  }
}

{
  "response_id": "abc-100",
  "error": {
    "code": "NOT_FOUND",
    "target": "flow",
    "message": "Flow not found.",
    "details": [
      {
        "target": "flow_id",
        "message": "Flow not found."
      }
    ]
  }
}

{
  "response_id": "abc-101",
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded for app key.",
    "details": []
  }
}

{
  "response_id": "abc-101",
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error.",
    "details": []
  }
}

Get a Single Flow

This API returns everything about one flow — its settings, targeting, conversion goal, and full stage-by-stage structure — typically after you find its flow_id with Search Flows. Use the optional version_no query parameter to view a specific version; by default, you get the last published version, or the draft if the flow was never published. Your API key must have the campaigns:view permission (see the Authentication section).

GET

flows

{flow_id}

Get a Single Flow

curl --request GET \
  --url https://api-{dc}.moengage.com/v5/flows/{flow_id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "response_id": "abc-100",
  "type": "flow",
  "data": {
    "flow_id": "69f1de84f9e401a2d7d9a931",
    "name": "Welcome journey",
    "status": "ACTIVE",
    "archived": false,
    "delivery_type": "EVENT_TRIGGERED",
    "tags": [
      "onboarding"
    ],
    "created_at": "2026-01-05T10:00:00Z",
    "updated_at": "2026-02-01T09:30:00Z",
    "published_at": "2026-01-06T08:00:00Z",
    "created_by": "[email protected]",
    "published_by": "[email protected]",
    "global_control_group_enabled": false,
    "active_version_name": "Version 2",
    "versions": [
      {
        "version_id": "69f1de84f9e401a2d7d9a931",
        "version_name": "Version 1",
        "version_no": 1,
        "status": "RETIRED"
      },
      {
        "version_id": "7a02ef95f9e401a2d7d9aa42",
        "version_name": "Version 2",
        "version_no": 2,
        "status": "ACTIVE"
      }
    ],
    "settings": {
      "control_group": {
        "enabled": false
      },
      "frequency_capping": {
        "ignore": false,
        "ignore_and_count": false
      },
      "bypass_dnd": false
    },
    "attribution": {
      "click_track_hours": 24,
      "impression_track_hours": 24
    },
    "conversion_goal_details": {
      "primary_goal": {
        "event": "Purchase",
        "goal_name": "Made a purchase"
      },
      "secondary_goals": [],
      "revenue_tracking": true,
      "revenue_attribute": "amount",
      "revenue_currency": "USD",
      "exit_on_conversion": false
    },
    "structure": {
      "nodes": [
        {
          "stage_id": "n1",
          "type": "TRIGGER",
          "sub_type": "EVENT",
          "parent_stage_id": null,
          "child_stage_ids": [
            "n2"
          ],
          "label": "App Opened",
          "config": {
            "schedule": {
              "delivery": "one_time",
              "start_time": "2026-01-06T08:00:00Z",
              "timezone": "Asia/Kolkata"
            },
            "segmentation": {
              "audience_type": "all_users"
            }
          }
        },
        {
          "stage_id": "n2",
          "type": "ACTION",
          "sub_type": "EMAIL",
          "parent_stage_id": "n1",
          "child_stage_ids": [],
          "label": "Welcome email",
          "config": {
            "campaign_id": "69f1de84f9e401a2d7d9a999",
            "channel": "EMAIL",
            "campaign_name": "Welcome email"
          }
        }
      ]
    }
  }
}

{
  "response_id": "abc-101",
  "error": {
    "code": "VALIDATION_FAILED",
    "target": "request",
    "message": "One or more request parameters failed validation.",
    "details": [
      {
        "target": "request",
        "message": "Check the request parameters and try again."
      }
    ]
  }
}

{
  "response_id": "abc-101",
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing credentials.",
    "details": []
  }
}

{
  "response_id": "abc-450",
  "error": {
    "code": "FORBIDDEN",
    "target": "permission",
    "message": "You do not have the required permission for this operation.",
    "details": [
      {
        "target": "permission",
        "message": "Required permission: campaigns:view"
      }
    ]
  }
}

{
  "response_id": "abc-100",
  "error": {
    "code": "NOT_FOUND",
    "target": "flow",
    "message": "Flow not found.",
    "details": [
      {
        "target": "flow_id",
        "message": "Flow not found."
      }
    ]
  }
}

{
  "response_id": "abc-101",
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded for app key.",
    "details": []
  }
}

{
  "response_id": "abc-101",
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error.",
    "details": []
  }
}

Rate Limits

The rate limits are at the workspace level. A maximum of 10 requests per second, 100 requests per minute, and 6,000 requests per hour are allowed per workspace.

Authorizations

Authorization

string

header

required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
Password: On your MoEngage workspace, navigate to Settings → Account → API keys and click Create new key. The tab lists every API surface (Data, Segmentation, Push, Email, Campaigns, Templates, and more) and exposes per-resource actions. Flows reuse the Campaigns permissions — ensure the View checkbox (for the read endpoints) and the Create & Manage checkbox (for Update Flow Status) are selected.

For more information on authentication and getting your credentials, refer to Getting your credentials.

Send the value in the Authorization header as Basic followed by Base64-encoding of appkey:apisecret (workspace ID and API key).

Headers

X-MOE-Tenant-ID

string

Identifies the tenant/workspace making the request. Optional — when omitted, the workspace is resolved from the Basic Auth credentials in the Authorization header.

X-MOE-Request-Id

string

Client-supplied trace ID. The server echoes it in the X-MOE-Request-Id response header and in response_id. If you omit it, the server generates one.

Path Parameters

flow_id

string

required

The 24-character ID of the flow. This must be the flow's own ID, not a version ID; passing a version ID returns 400.

Pattern: ^[a-f0-9]{24}$

Example:

"6a3b09c938da57c8f5838880"

Query Parameters

version_no

integer

View a specific version of the flow by its version number (the trailing integer of the version name, for example Version 3 becomes 3). When omitted, the last published version is returned, or the draft if none is published. A non-integer value returns 400; a number that does not exist for this flow returns 404.

Required range: x >= 1

Response

Flow found.

response_id

string

required

type

enum<string>

required

Available options:

flow

data

object

required

Full single-flow detail. Carries every FlowSummary field plus the version list, publish metadata, settings, attribution, conversion goal, and its stages.

Show child attributes

Search Flows Get a Specific Version of a Flow

⌘I

​Rate Limits

Authorizations

Headers

Path Parameters

Query Parameters

Response

Rate Limits