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.
| Attribute | Type | Nullable | Description |
|---|---|---|---|
id | string (UUID) | No | Service identifier. |
icon | string | Yes | Icon name or reference. |
title | string | No | Service title. |
description | string | No | Displayed description. |
ctaLabel | string | Yes | Action label. |
ctaUrl | string | Yes | Action URL. |
displayOrder | number | No | Display order. |
isActive | boolean | No | Activation state. |
Status codes
- 200 OK
- 400 Bad Request (invalid reference)