API Reference
Zone name
Return the public zone name/label for portal branding.
GET /api/companies/public/{companyRef}/nameAccess : Public
Operator use case
On portal load, display the exact zone name automatically (e.g. ED Center).
Parameters
- companyRef (path, required)
companyRef is a string containing the public zone reference. In portal code, the local {ref} placeholder represents the same value.
Response body
{
"name": "ReadyZone Center",
"label": "ReadyZone Center",
"reference": "ed-center-68819"
}| Attribute | Type | Nullable | Description |
|---|---|---|---|
name | string | No | Primary zone name. |
label | string | Yes | Public zone label. |
reference | string | No | Public reference returned by the API. |
Status codes
- 200 OK
- 400 Bad Request (company not found)