API Reference
Public advertisements
List public advertisements for a zone.
GET /api/advertisements/public?companyRef={companyRef}Access: Public
Portal use case
Load active advertisements, their media, and any associated actions in the portal.
Parameters
- companyRef (query, optional)
Response
The response is a JSON array of active public advertisements.
| Attribute | Type | Nullable | Description |
|---|---|---|---|
id | string (UUID) | No | Advertisement identifier. |
category | string | No | Advertisement category. |
type | string | No | text, image, video, or mixed. |
title | string | Yes | Display title. |
content | string | No | Text content. |
mediaUrl | string | Yes | Image or video URL. |
actionLabel | string | Yes | Action button label. |
actionUrl | string | Yes | URL opened by the action. |
displayOrder | number | No | Display order. |
isActive | boolean | No | Activation state. |
expirationAt | string (ISO 8601) | Yes | Expiration date. |
Status codes
- 200 OK
- 400 Bad Request (invalid reference)