API Reference
Public announcements
List public announcements for a zone.
GET /api/announcements/public?companyRef={companyRef}Access: Public
Portal use case
Load active announcements displayed in the portal information section.
Parameters
- companyRef (query, optional)
Response
The response is a JSON array of active public announcements.
| Attribute | Type | Nullable | Description |
|---|---|---|---|
id | string (UUID) | No | Announcement identifier. |
category | string | No | Category, such as Information or Alert. |
content | string | No | Displayed content. |
isActive | boolean | No | Activation state. |
expirationAt | string (ISO 8601) | Yes | Expiration date. |
companyId | string (UUID) | Yes | Associated zone, null for a global announcement. |
createdAt | string (ISO 8601) | No | Creation date. |
updatedAt | string (ISO 8601) | No | Update date. |
Status codes
- 200 OK
- 400 Bad Request (invalid reference)