Get home page content

Get home page content

Returns the current home page draft content — hero banner, popular searches, cards, and footer blocks. The response structure matches the PATCH request body shape, so you can read, modify, and send back.

Query Parameters
  • site
    string

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

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


{
  "title": "<h1>Welcome to Our Docs</h1>",
  "subtitle": "<p>Find everything you need here.</p>",
  "backgroundImageFileName": "Storage/Branding/bg.jpg",
  "popularSearches": {
    "label": "Popular:",
    "searches": [
      "getting started",
      "installation"
    ],
    "isShow": true
  },
  "cardList": {
    "title": "<h2>Documentation</h2>",
    "layoutType": "vertical",
    "align": "center",
    "showDescriptions": true,
    "cards": [
      {
        "id": "card-a1b2c3d4",
        "title": "Getting Started",
        "description": "Learn the basics in minutes.",
        "icon": {
          "type": "IconicFont",
          "iconicFontCssClass": "fas fa-book",
          "iconicFontColor": "#3399ff",
          "isDefaultColor": false,
          "imageFullFileName": null
        },
        "link": {
          "type": "externalLink",
          "href": "https://docs.example.com/getting-started",
          "isOpenInNewTab": true
        }
      }
    ]
  },
  "footer": {
    "layoutType": "two",
    "columns": [
      {
        "id": "col-a1b2c3d4",
        "content": "<p>© 2024 Acme Corp</p>"
      }
    ]
  }
}

OK