API Reference
Support contact
Retrieve a zone’s public support contact details.
GET /api/companies/public/{companyRef}/contactAccess: Public
Portal use case
The portal uses this endpoint to display the email address and phone number in the “Need help?” dialog.
Parameters
- companyRef (path, required)
Response body
{
"email": "support@readyzone.example",
"phone": "+237699112233"
}| Attribute | Type | Nullable | Description |
|---|---|---|---|
email | string | Yes | Public support email address. |
phone | string | Yes | Public support phone number. |
A null value must not be rendered as an empty button.
Status codes
- 200 OK
- 400 Bad Request (invalid zone)
- 404 Not Found (contact details unavailable)