Search Flows - MoEngage

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

POST

/

v5

/

flows

/

search

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). 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.

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

tags

string[]

The tag names to match; flows that carry any of them are kept.

teams

string[]

Team names. Required when the Flows-teams feature is enabled for the workspace — omitting it or sending an empty list returns 400 VALIDATION_FAILED ("teams is required when the team feature is enabled"). When the feature is off, sending teams is rejected with 400.

name

string

Matches flows whose name contains this text, case-insensitively.

created_by

string<email>[]

The email addresses of the flow creators to filter by.

creation_start_time

string

The inclusive lower bound on the creation time, in ISO 8601 UTC format.

Example:

"2025-01-01T00:00:00Z"

creation_end_time

string

The inclusive upper bound on the creation time, in ISO 8601 UTC format. It must be on or after creation_start_time.

Example:

"2026-12-31T23:59:59Z"

include_archived

boolean

default:false

false (default) excludes archived flows; true returns both archived and non-archived.

limit

integer

default:20

The number of results returned per page.

Required range: 1 <= x <= 100

cursor

string

The cursor from a previous page's next_cursor. Omit for the first page.

Response

Flows matching the filters, most recently updated first. Sorting is not supported in this version.

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

Show child attributes