Skip to main content
GET
List Offerings

Rate Limit

The rate limit is 150 requests per minute, 500 requests per hour, and 1000 requests per day per consumer.

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 dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
  • Password: On your MoEngage workspace, navigate to Settings > Account > API keys. Use the Key listed within the Personalize tile.

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-Request-Id
string<uuid>

Client-supplied trace ID (UUID v4). Echoed back in the X-MOE-Request-Id response header.

Query Parameters

id
string

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.

name_contains
string

Find offerings whose name contains specific text (case-insensitive). For example, pass "summer" to find all summer-related offerings.

Maximum string length: 100
status_in
string

Filter by lifecycle status. Valid values: active, scheduled, expired, archived, draft. Example: status_in=active,scheduled

tags
string[]

Filter to offerings that have ALL of the specified tags. Repeat the parameter for multiple tags: tags=summer-sale&tags=vip-users.

created_date_gte
string<date>

List offerings created on or after this date. Format: YYYY-MM-DD.

created_date_lte
string<date>

List offerings created on or before this date. Format: YYYY-MM-DD.

created_by
string[]

Filter offerings created by specific team members. Pass one or more email addresses. Example: created_by=john.doe@example.com,marketing-team@example.com

fields
string

Request only the fields you need. Example: fields=id,name,status returns only those three fields per item.

cursor
string

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.

limit
integer
default:20

Items per page. Default 20, max 100.

Required range: 1 <= x <= 100

Response

Paginated list of offerings.

response_id
string
required

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

type
enum<string>
required
Available options:
offer
data
object[]
required

List of offering summaries matching the applied filters.

pagination
object
required

Pagination metadata included in list responses.