curl --request GET \
--url https://api-{dc}.moengage.com/v5/offers \
--header 'Authorization: Basic <encoded-value>'{
"response_id": "resp_d31d6d61-6f3b-40dc-a459-548f385a60cb",
"type": "offer",
"data": [
{
"id": "offer_6a4f69ee490f66322f968b87",
"display_name": "Summer_Sale_Promo_2026",
"status": "active",
"tags": [
"tag_<object-id>"
],
"created_at": "2026-06-23T12:29:41.225270281Z",
"created_by": "[email protected]"
},
{
"id": "offer_6a4f69ee490f66322f968b87",
"display_name": "Homepage_Banner_AB_Test",
"status": "scheduled",
"created_at": "2026-06-23T12:29:41.225270281Z",
"created_by": "[email protected]"
}
],
"pagination": {
"next_cursor": "b2ZmZXJzOjZhM2E3YzM0NTE4NjdkNGRjZmIxNzQ5Mw==",
"limit": 20,
"has_more": true,
"total_count": 42
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "One or more query parameters are invalid.",
"doc_url": "https://www.moengage.com/docs/api/offerings/offerings-overview",
"details": [
{
"code": "INVALID_ENUM_VALUE",
"target": "status_in",
"message": "'invalid_status' is not a valid status. Allowed values: active, scheduled, expired, archived, draft.",
"doc_url": "https://www.moengage.com/docs/api/offerings/offerings-overview"
}
]
},
"response_id": "resp_<trace-id>"
}"{\"code\":\"ER001\",\"target\":\"Authentication Invalid\",\"message\":\"Auth validation failed.\"}""{\"code\":\"ER001\",\"target\":\"Authentication Invalid\",\"message\":\"Auth validation failed.\"}"{
"response_id": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"doc_url": "https://www.moengage.com/docs/api/offerings/offerings-overview",
"target": "<string>",
"details": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
]
}
}"<html><body><h1>503 Service Temporarily Unavailable</h1></body></html>"List Offerings
Fetch all offerings in the workspace. Returns a summary of each offering — ID, name, status, tags, and creation metadata.
curl --request GET \
--url https://api-{dc}.moengage.com/v5/offers \
--header 'Authorization: Basic <encoded-value>'{
"response_id": "resp_d31d6d61-6f3b-40dc-a459-548f385a60cb",
"type": "offer",
"data": [
{
"id": "offer_6a4f69ee490f66322f968b87",
"display_name": "Summer_Sale_Promo_2026",
"status": "active",
"tags": [
"tag_<object-id>"
],
"created_at": "2026-06-23T12:29:41.225270281Z",
"created_by": "[email protected]"
},
{
"id": "offer_6a4f69ee490f66322f968b87",
"display_name": "Homepage_Banner_AB_Test",
"status": "scheduled",
"created_at": "2026-06-23T12:29:41.225270281Z",
"created_by": "[email protected]"
}
],
"pagination": {
"next_cursor": "b2ZmZXJzOjZhM2E3YzM0NTE4NjdkNGRjZmIxNzQ5Mw==",
"limit": 20,
"has_more": true,
"total_count": 42
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "One or more query parameters are invalid.",
"doc_url": "https://www.moengage.com/docs/api/offerings/offerings-overview",
"details": [
{
"code": "INVALID_ENUM_VALUE",
"target": "status_in",
"message": "'invalid_status' is not a valid status. Allowed values: active, scheduled, expired, archived, draft.",
"doc_url": "https://www.moengage.com/docs/api/offerings/offerings-overview"
}
]
},
"response_id": "resp_<trace-id>"
}"{\"code\":\"ER001\",\"target\":\"Authentication Invalid\",\"message\":\"Auth validation failed.\"}""{\"code\":\"ER001\",\"target\":\"Authentication Invalid\",\"message\":\"Auth validation failed.\"}"{
"response_id": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"doc_url": "https://www.moengage.com/docs/api/offerings/offerings-overview",
"target": "<string>",
"details": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
]
}
}"<html><body><h1>503 Service Temporarily Unavailable</h1></body></html>"Rate Limit
The rate limit is 150 requests per minute, 500 requests per hour, and 1000 requests per day per consumer.承認
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.
ヘッダー
Client-supplied trace ID (UUID v4). Echoed back in the X-MOE-Request-Id response header.
クエリパラメータ
Look up a single offering by its exact prefixed ID (e.g. offer_6a4f69ee490f66322f968b87). Use this when you already know the offering ID and want to confirm it exists before updating it.
Find offerings whose display name contains specific text (case-insensitive). For example, pass "summer" to find all summer-related offerings.
100Filter by lifecycle status. Valid values: active, scheduled, expired, archived, draft. Example: status_in=active,scheduled
Filter to offerings that have ALL of the specified tags. Repeat the parameter for multiple tags: tags=summer-sale&tags=vip-users.
List offerings created on or after this date. Format: YYYY-MM-DD.
List offerings created on or before this date. Format: YYYY-MM-DD.
Filter offerings created by specific team members. Pass one or more email addresses. Example: created_by=[email protected],[email protected]
Request only the fields you need. Example: fields=id,display_name,status returns only those three fields per item.
Pagination cursor returned as next_cursor in the previous response. Omit on the first request. When next_cursor is null in the response, you have reached the last page.
Items per page. Default 20, max 100.
1 <= x <= 100レスポンス
Paginated list of offerings.
Format: resp_<X-MOE-Request-Id> header value (auto-generated UUID if the X-MOE-Request-Id header was not part of the request body).
offer List of offering summaries matching the applied filters.
Show child attributes
Show child attributes
Pagination metadata included in list responses.
Show child attributes
Show child attributes