Skip to content
ReadyZone Docs
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.

AttributeTypeNullableDescription
idstring (UUID)NoAnnouncement identifier.
categorystringNoCategory, such as Information or Alert.
contentstringNoDisplayed content.
isActivebooleanNoActivation state.
expirationAtstring (ISO 8601)YesExpiration date.
companyIdstring (UUID)YesAssociated zone, null for a global announcement.
createdAtstring (ISO 8601)NoCreation date.
updatedAtstring (ISO 8601)NoUpdate date.

Status codes

  • 200 OK
  • 400 Bad Request (invalid reference)

On this page