High-performance, CDN-optimized API for integrating content, circulars, and offers into your web applications
Make your first API request in seconds:
const response = await fetch('https://cdn.engagehq.retailsuccessplatform.com/api/v1/public/content', {
headers: {
'Authorization': 'Bearer YOUR_JWT_TOKEN',
},
});
const { data } = await response.json();
console.log(data); // Array of published content items| Environment | URL | Purpose |
|---|---|---|
| Production (CDN) | https://cdn.engagehq.retailsuccessplatform.com/api/v1/public | Public content delivery (recommended) |
| Production (direct) | https://api.engagehq.retailsuccessplatform.com/api/v1/public | Admin/management API |
| Staging | https://api-staging.engagehq.retailsuccessplatform.com/api/v1/public | Staging environment |
Use the CDN endpoint
For public content delivery, always use cdn.engagehq.retailsuccessplatform.com. Content is cached at edge locations worldwide and automatically invalidated when published, giving you the best performance and guaranteed freshness.
| Endpoint | Description |
|---|---|
GET /content | List published content items |
GET /content/{slug} | Get a specific content item |
GET /circulars | List available circulars |
GET /circulars/{id} | Get circular with layout data |
GET /offers | List active offers |
GET /offers/{id} | Get offer details |
All endpoints return a consistent JSON structure:
{
"success": true,
"message": "Content retrieved",
"data": [ /* array or object */ ],
"meta": {
"current_page": 1,
"last_page": 5,
"per_page": 20,
"total": 94
}
}| Date | Change |
|---|---|
| 2026-03-24 | Added custom types and platform elements features. |
| 2026-02-23 | Updated for CloudFront CDN delivery. |
| 2026-01-28 | Expanded documentation. |
| 2026-01-15 | Initial publication. |