List Offerings
This API returns a paginated list of offerings in the authenticated workspace. Use the query
parameters to filter by ID, name, status, tags, creation date, or creator, and to
request a sparse set of fields. Requires the read:offers scope.
Rate Limit
The rate limits are at the workspace level. Each endpoint allows 100 requests per minute, 300 requests per hour, and 600 requests per day.Authorizations
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: Use your API Key, which you can find within the Personalize tile.
For more information on authentication and getting your credentials, refer here.
Headers
Client-supplied trace ID (UUID v4). The server echoes it in the X-MOE-Request-Id response header and records it in its logs, so you can correlate a client request with server-side activity. If you omit it, the server generates one.
Query Parameters
Filter by exact offering ID, including the offer_ prefix.
Case-insensitive substring match on the offering name. Maximum 100 characters; a longer value returns 400 OUT_OF_RANGE.
100Comma-separated list of statuses to match (OR semantics — an offering is returned if its status matches any value). Case-insensitive. Valid values: active, scheduled, expired, archived, draft. Example: status_in=active,scheduled.
Filter by tag ID (AND semantics — an offering is returned only if it has all specified tags). Repeat the parameter for each tag: tags=tag_summer_sale&tags=tag_loyalty.
Return offerings created on or after this date (YYYY-MM-DD).
Return offerings created on or before this date (YYYY-MM-DD).
Filter by creator email address. Repeat the parameter for multiple creators: [email protected]&[email protected].
Comma-separated list of fields to include for each item. Case-sensitive. Defaults to all six fields: id, name, status, tags, created_at, created_by. An unrecognized field name returns 400 INVALID_FIELDS_PARAM. Example: fields=id,name,status.
Page number to retrieve, starting at 1. Maximum 500; a higher value returns 400 OUT_OF_RANGE. When the page number exceeds the total number of available pages, returns an empty items array (not an error).
1 <= x <= 500Number of items per page. Default 20, maximum 100.
1 <= x <= 100