Get home page settings

Get home page settings

Returns the home page settings (appearance and SEO metadata) as a flat key-value JSON object. By default returns the current draft state. Pass published=true to get the live published version.

Query Parameters
  • published
    boolean

    When true, returns the published version; otherwise returns the draft. Default is false.

  • site
    string

    Domain name of the site whose home page settings to retrieve. Omit to use the default site.

    Exampledocs.example.com
Responses
GET/system-pages/home/settings


{
  "fontName": "Arial",
  "fontColor": "#333333",
  "backgroundColor": "#ffffff",
  "linkColor": "#0066cc",
  "title": "My Portal",
  "metaDescription": "Find all documentation here.",
  "metaKeywords": "docs, help",
  "additionalTags": null
}

OK