Skip to main content
GET
Get a Single Flow

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). Find it in the MoEngage dashboard at Settings > Account > API keys.
  • Password: Use an API key from Settings > Account > API keys.

Refer to API Key Dashboard for details on creating and managing API keys.

Headers

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

Echo of the X-MOE-Request-Id that you supplied. When you omit it, MoEngage returns the first 12 characters of a system-generated UUID.

type
enum<string>

The type of resource the response describes.

Available options:
flow
data
object

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