Skip to content
ReadyZone Docs
API Reference

Public services

List public services for a zone.

GET /api/services/public?companyRef={companyRef}

Access: Public

Portal use case

Load active services offered by the zone in the captive portal.

Parameters

  • companyRef (query, optional)

Response

The response is a JSON array of active public services.

AttributeTypeNullableDescription
idstring (UUID)NoService identifier.
iconstringYesIcon name or reference.
titlestringNoService title.
descriptionstringNoDisplayed description.
ctaLabelstringYesAction label.
ctaUrlstringYesAction URL.
displayOrdernumberNoDisplay order.
isActivebooleanNoActivation state.

Status codes

  • 200 OK
  • 400 Bad Request (invalid reference)

On this page