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

AttributeTypeNullableDescription
idstring (UUID)NoAdvertisement identifier.
categorystringNoAdvertisement category.
typestringNotext, image, video, or mixed.
titlestringYesDisplay title.
contentstringNoText content.
mediaUrlstringYesImage or video URL.
actionLabelstringYesAction button label.
actionUrlstringYesURL opened by the action.
displayOrdernumberNoDisplay order.
isActivebooleanNoActivation state.
expirationAtstring (ISO 8601)YesExpiration date.

Status codes

  • 200 OK
  • 400 Bad Request (invalid reference)

On this page