curl --request POST \
  --url https://api-{dc}.moengage.com/v5/flows/search \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 20
}'

{
  "response_id": "abc-701",
  "type": "flow",
  "data": {
    "flows": [
      {
        "flow_id": "69f1de84f9e401a2d7d9a931",
        "name": "Welcome journey",
        "status": "ACTIVE",
        "archived": false,
        "delivery_type": "EVENT_TRIGGERED",
        "active_version_name": "Version 2",
        "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]"
      }
    ],
    "has_more": true,
    "next_cursor": "eyJpZCI6ICI2OWYxZGU4NGY5ZTQwMWEyZDdkOWE5MzEifQ=="
  }
}

{
  "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-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": []
  }
}

Search Flows

This API returns a paginated list of flows matching your filters. Send filters in the request body — all are optional and combine with AND. Multi-valued filters (status, delivery_type, tags) match ANY of the supplied values, and archived flows are excluded unless include_archived is true.

Each response includes a next_cursor. To get the next page, send that value as the cursor in your next request. Sorting is not supported in this version; results are returned most recent first. Your API key must have the campaigns:view permission (see Authentication).

POST

flows

curl --request POST \
  --url https://api-{dc}.moengage.com/v5/flows/search \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 20
}'

{
  "response_id": "abc-701",
  "type": "flow",
  "data": {
    "flows": [
      {
        "flow_id": "69f1de84f9e401a2d7d9a931",
        "name": "Welcome journey",
        "status": "ACTIVE",
        "archived": false,
        "delivery_type": "EVENT_TRIGGERED",
        "active_version_name": "Version 2",
        "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]"
      }
    ],
    "has_more": true,
    "next_cursor": "eyJpZCI6ICI2OWYxZGU4NGY5ZTQwMWEyZDdkOWE5MzEifQ=="
  }
}

{
  "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-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.

Body

application/json

Filters for listing flows. All filters are optional and combine with AND. Enum filters (status, delivery_type) are case-insensitive.

request_id

string

Optional if supplied via the X-MOE-Request-Id header; echoed in response_id.

status

enum<string>[]

Keeps only flows whose status is in this set.

Public lifecycle status of a flow (or of a specific version), independent of the archived flag.

Available options:

DRAFT,

ACTIVE,

SCHEDULED,

PAUSED,

STOPPED,

COMPLETED,

RETIRED,

UNDER_REVIEW,

REJECTED

delivery_type

enum<string>[]

Keeps only flows that have one of these delivery types.

Indicates how users enter the flow.

Available options:

ONE_TIME,

PERIODIC,

ON_FLOW_EXIT,

EVENT_TRIGGERED,

BUSINESS_EVENT_TRIGGERED

Response

Flows matching the filters.

response_id

string

required

Echo of the request_id that you supplied, or a generated ID when absent.

type

enum<string>

required

Available options:

flow

data

object

required

Show child attributes

Flows Overview Get a Single Flow

⌘I

​Rate Limits

Authorizations

Headers

Body

Response

Rate Limits