GET/hyax-api/v1/settings

Get site settings

Returns full site settings (secrets redacted) plus teamDomain/teamUsername. Response includes writableFields — the only keys accepted by PATCH.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X GET 'https://platform.hyax.com/hyax-api/v1/settings' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "writableFields": ["siteName", "title", "socialTwitter", "..."],
  "data": {
    "siteName": "My Site",
    "title": "Welcome",
    "logoUrl": "https://…",
    "teamDomain": null,
    "teamUsername": "acme"
  }
}