Get Campaign (V5)

Returns the full configuration and current status of a single campaign by its ID.

GET /v5/campaigns/{campaign_id}

cURL

Get campaign by ID (cURL)

curl -X GET 'https://api-{dc}.moengage.com/v5/campaigns/{{campaign_id}}' \
  -H 'Authorization: Basic {{auth_token}}' \
  -H 'MOE-APPKEY: {{workspace_id}}' \
  -H 'X-MOE-Request-Id: {{request_id}}'

200

scheduled_push_campaign

{
  "response_id": "abc-100",
  "type": "campaign",
  "data": {
    "id": "64a1b2c3d4e5f6a7b8c9d0e1",
    "campaign_id": "64a1b2c3d4e5f6a7b8c9d0e1",
    "status": "SCHEDULED",
    "channel": "PUSH",
    "campaign_delivery_type": "ONE_TIME",
    "created_by": "[e-mail]",
    "updated_by": "[e-mail]",
    "created_at": "2024-07-04 08:00:54.847000",
    "updated_at": "2024-07-04 09:15:00.000000",
    "basic_details": {
      "name": "Summer Sale Push",
      "platforms": [
        "ANDROID",
        "IOS"
      ],
      "tags": [
        "promotional",
        "seasonal"
      ],
      "team": "Growth Team"
    },
    "campaign_content": {
      "content": {
        "push": {
          "android": {
            "template_type": "BASIC",
            "basic_details": {
              "title": "Summer Sale — Up to 50% off",
              "message": "Shop now before the sale ends.",
              "default_click_action": "DEEPLINKING",
              "default_click_action_value": "https://example.com/sale"
            }
          },
          "ios": {
            "template_type": "BASIC",
            "basic_details": {
              "title": "Summer Sale — Up to 50% off",
              "message": "Shop now before the sale ends.",
              "default_click_action": "DEEPLINKING",
              "default_click_action_value": "https://example.com/sale"
            }
          }
        }
      }
    },
    "scheduling_details": {
      "delivery_type": "SCHEDULED",
      "schedule_time": "2024-11-28T12:00:00",
      "time_zone": "UTC"
    },
    "segmentation_details": {
      "included_filters": {
        "filter_operator": "and",
        "filters": [
          {
            "filter_type": "custom_segments",
            "name": "segment",
            "id": "seg_abc123"
          }
        ]
      }
    },
    "delivery_controls": {
      "bypass_dnd": false,
      "ignore_frequency_capping": false
    },
    "utm_params": {
      "utm_source": "moengage",
      "utm_medium": "push",
      "utm_campaign": "summer_sale_2024"
    }
  }
}

SMS campaigns: SMS campaigns are returned by this endpoint; the response channel field will be SMS. The connector and sender_name fields carry SMS-specific details. SMS campaigns can be retrieved but must be created and managed through the MoEngage dashboard or V1 APIs in the interim.

Rate Limits

Rate Limit Name	Rate Limit
Get campaign per second	The total number of get campaign requests per second per client allowed is 10.
Get campaign per minute	The total number of get campaign requests per minute per client allowed is 100.
Get campaign per hour	The total number of get campaign requests per hour per client allowed is 6000.

Notes

• Breaching the limits will reject the request.
• Per-hour limits use a rolling window of the last 1 hour.

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

MOE-APPKEY · string

Your MoEngage Workspace ID (App ID). Optional — Basic Auth already carries the Workspace ID as the username, so this header is not required. Find it in the dashboard at Settings > Account > API keys.

X-MOE-Request-Id · string

Client-supplied trace ID for tracing. Correlates with response_id. Supply this header or request_id in the body; if both are set, they must match.

Path Parameters

campaign_id · string · required

Raw 24-char ObjectId of the campaign to retrieve.

Response

200

application/json

Campaign details retrieved successfully.

response_id · string

type · string

Example:

"campaign"

data · object

Detailed information about a campaign returned by GET /v5/campaigns/{campaign_id} and POST /v5/campaigns/search.

Identifier change from V1 to V5:

• In V1, the campaign identifier was returned as campaign_id. In V5, it is returned as id.
• The legacy campaign_id field may also be present alongside id for backward compatibility, but id is the canonical V5 identifier.

V1 fields preserved in V5 under the same names: created_by, updated_by, created_at, updated_at, sent_time, flow_id, flow_name, parent_id, connector, utm_params, campaign_audience_limit.

Show child attributes