Get the chrome in a space

Embed
Preview of the card
<a href="https://forumulate.com/reference/forumulate-api-public-chrome"><img src="https://forumulate.com/reference/_api/public/orgs/046a9bc0-d530-43ae-9bae-af7945008cda/spaces/8042f004-e3d9-445f-b7a4-b6c1f86836e6/pages/afdf9fd9-3f82-495b-a9a5-d89202a2472a/social-card.svg?v=3e7ae33eec8b" alt="Get the chrome in a space" width="600" height="315"></a>
GEThttps://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/chrome

The furniture a given page actually wears — header, footer, announcement, resolved theme and the alternates a visitor may pick. For a space inside a site it reports the site’s, with the space theme layered over it, because that is what renders; the space’s own stored header is kept and deliberately unused.

Parameters
orgIdstringpathrequired
spaceIdstringpathrequired
sharestringquery
previewstringquery
forumulate-versionstringheader
API version negotiation. Send forumulate-version: 2026-12-01 on every request from a new integration; it is optional only so that integrations written before versioning keep working. Each version includes everything before it:
Code samples
cURL
curl -X GET "https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/chrome?share=&preview=" \
  -H "forumulate-version: <value>"
TypeScript
const res = await fetch('https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/chrome?share=&preview=', {
  method: 'GET',
  headers: {
    'forumulate-version': '<value>',
  },
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/chrome?share=&preview=",
    headers={
    "forumulate-version": "<value>",
    },
)
data = res.json()
Go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/chrome?share=&preview=", nil)
	req.Header.Set("forumulate-version", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/chrome?share=&preview=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['forumulate-version: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/chrome?share=&preview=')
req = Net::HTTP::Get.new(uri)
req['forumulate-version'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/chrome?share=&preview="))
    .header("forumulate-version", "<value>")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 Success.
Example
{
  "analytics": {
    "customHead": "string",
    "fathom": "string",
    "ga4": "string",
    "gtm": "string",
    "intercom": "string",
    "matomo": "string",
    "matomoHost": "string",
    "plausible": "string",
    "plausibleHost": "string",
    "posthog": "string",
    "posthogHost": "string",
    "segment": "string",
    "simpleAnalytics": "string",
    "umami": "string",
    "umamiHost": "string"
  },
  "announcement": {
    "audience": "all",
    "background": "string",
    "backgroundDark": "string",
    "bleed": true,
    "button": {
      "label": "string"
    },
    "dismissible": true,
    "gradient": {
      "angle": 0,
      "stops": [
        null
      ],
      "type": "linear"
    },
    "href": "string",
    "ink": "string",
    "inkDark": "string",
    "inset": true,
    "lead": "string",
    "level": "danger",
    "pages": [
      "string"
    ],
    "phone": "full",
    "placement": "above-header",
    "radius": 0,
    "release": {
      "fallback": "hide",
      "maxAgeDays": 0,
      "only": "any",
      "spaceId": "string"
    },
    "source": "latest-release",
    "span": "content",
    "style": "bar",
    "text": "string"
  },
  "chatWidgets": [
    {
      "connectOrigins": [
        "string"
      ],
      "consent": "analytics",
      "origin": "string",
      "placement": "anywhere",
      "providerId": "string",
      "providerName": "string",
      "script": "string",
      "src": "string",
      "theme": {}
    }
  ],
  "chrome": {
    "accountMenu": {
      "bell": true,
      "items": [
        null
      ],
      "showAvatar": true,
      "showName": true
    },
    "align": "center",
    "brandText": "auto",
    "copyright": "string",
    "cta": {
      "audience": "all",
      "background": "string",
      "border": "string",
      "borderDark": "string",
      "fontSize": 0,
      "height": 0,
      "href": "string",
      "icon": "string",
      "ink": "string",
      "inkDark": "string",
      "label": "string",
      "phone": "bar",
      "showOnPhone": true,
      "size": "lg"
    },
    "ctas": [
      {
        "action": null,
        "audience": null,
        "background": null,
        "border": null,
        "borderDark": null,
        "fontSize": null,
        "height": null,
        "href": null,
        "icon": null,
        "ink": null,
        "inkDark": null,
        "label": null,
        "phone": null,
        "showOnPhone": null,
        "size": null,
        "style": null,
        "underline": null
      }
    ],
    "ctaStyle": "link",
    "desktopNav": "inline",
    "footer": {
      "art": {
        "blur": null,
        "clip": null,
        "color": null,
        "direction": null,
        "fade": null,
        "fit": null,
        "glowAlign": null,
        "glowBelow": null,
        "glowWidth": null,
        "height": null,
        "image": null,
        "offsetY": null,
        "opacity": null,
        "placement": null,
        "position": null,
        "preset": null
      },
      "background": {
        "color": null,
        "colorDark": null,
        "edge": null,
        "gradient": null,
        "image": null
      },
      "border": true,
      "bottomAlign": "columns",
      "bottomRule": true,
      "bottomSize": 0,
      "brandPlacement": "bottom",
      "brandWidth": null,
      "breadcrumb": true,
      "breadcrumbPlacement": "bottom",
      "columnRule": true,
      "columns": null,
      "columnWidth": 0,
      "contentWidth": "string",
      "cookieLinkPlacement": "bottom",
      "css": "string",
      "font": "body",
      "headingFont": "body",
      "headingGap": 0,
      "headingInk": "string",
      "headingInkDark": "string",
      "headingSize": 0,
      "headingStyle": "label",
      "headingWeight": 0,
      "hideOn": [
        null
      ],
      "html": "string",
      "htmlLinkInk": "string",
      "htmlLinkInkDark": "string",
      "htmlLinkUnderline": true,
      "htmlPlacement": "above",
      "htmlSize": 0,
      "layout": "rows",
      "linkGap": 0,
      "linkInk": "string",
      "linkInkDark": "string",
      "linkSeparator": "dot",
      "linkSize": 0,
      "linkWeight": 0,
      "logo": null,
      "logoMark": null,
      "newsletter": {
        "button": null,
        "consent": null,
        "consentPlacement": null,
        "formId": null,
        "heading": null,
        "headingWidth": null,
        "hideLabel": null,
        "layout": null,
        "padding": null,
        "placement": null,
        "rule": null,
        "splitRatio": null,
        "subheading": null
      },
      "padding": {
        "bottom": null,
        "top": null
      },
      "phone": "accordion",
      "scheme": "dark",
      "showBrandName": true,
      "socialSize": 0,
      "socialStyle": "circle",
      "status": {
        "case": null,
        "color": null,
        "dot": null,
        "font": null,
        "monitorSpaceId": null,
        "style": null
      },
      "width": "string"
    },
    "footerColumns": [
      {
        "audience": null,
        "heading": null,
        "links": null,
        "stack": null
      }
    ],
    "footerDescription": "string",
    "footerLinks": [
      {
        "audience": null,
        "href": null,
        "label": null
      }
    ],
    "header": {
      "accentTop": {
        "color": null,
        "width": null
      },
      "activeMatch": "auto",
      "activeStyle": "pill",
      "background": {
        "gradient": null,
        "gradientDark": null
      },
      "blur": 0,
      "border": null,
      "borderColor": "string",
      "borderSpan": "bar",
      "brandPrefix": {
        "ink": null,
        "inkDark": null,
        "text": null
      },
      "brandSize": null,
      "controlsAlign": "end",
      "ctaDivider": true,
      "floating": {
        "inset": null,
        "maxWidth": null,
        "phone": null,
        "radius": null
      },
      "group": {
        "align": null,
        "width": null
      },
      "groupOnScroll": "full",
      "height": null,
      "iconSize": null,
      "linksAlign": "after-search",
      "logoHeight": null,
      "logoHref": "string",
      "maxLinks": 0,
      "menuButton": {
        "background": null,
        "desktop": null,
        "glyph": null,
        "ink": null,
        "phone": null,
        "phoneSide": null,
        "radius": null,
        "size": null
      },
      "navCase": "capitalize",
      "navFont": "body",
      "navGap": 0,
      "navInk": "string",
      "navInkDark": "string",
      "navSeparator": "string",
      "navSize": 0,
      "navTracking": 0,
      "navWeight": 0,
      "opacity": 0,
      "order": [
        null
      ],
      "overlay": true,
      "overlayInk": "string",
      "paint": "brand",
      "phoneLayout": "row",
      "scrollTitle": null,
      "scrollTitleFont": "body",
      "sectionCrumb": true,
      "sectionCrumbSeparator": "string",
      "shadow": "lg"
    },
    "headerLinks": [
      {
        "audience": null,
        "border": null,
        "borderDark": null,
        "children": null,
        "divider": null,
        "githubRepo": null,
        "highlight": null,
        "href": null,
        "icon": null,
        "iconDark": null,
        "iconOnly": null,
        "ink": null,
        "inkDark": null,
        "kbd": null,
        "label": null,
        "match": null,
        "panel": null,
        "phone": null,
        "placement": null,
        "style": null
      }
    ],
    "height": "compact",
    "logoPhone": "full",
    "mobileNav": "bar",
    "navMenu": {
      "animation": "fade",
      "background": "string",
      "border": "string",
      "closeDelay": 0,
      "ink": "string",
      "openDelay": 0,
      "radius": 0,
      "shadow": "lg",
      "trigger": "click",
      "width": 0
    },
    "search": "icon",
    "searchHideOn": [
      "desktop"
    ],
    "searchPlacement": "before-links",
    "searchStyle": {
      "background": "string",
      "backgroundDark": "string",
      "glyph": true,
      "iconFrame": "circle",
      "ink": "string",
      "inkDark": "string",
      "kbd": "mod-k",
      "kbdStyle": "caps",
      "label": "string",
      "labelPhone": "string",
      "open": "box",
      "shrink": true,
      "size": "md",
      "width": 0
    },
    "secondaryCta": {
      "audience": "all",
      "background": "string",
      "border": "string",
      "borderDark": "string",
      "fontSize": 0,
      "height": 0,
      "href": "string",
      "ink": "string",
      "inkDark": "string",
      "label": "string",
      "phone": "bar",
      "showOnPhone": true,
      "size": "lg",
      "style": "link",
      "underline": true
    },
    "showSignIn": true,
    "sidebarBrand": "hide",
    "sidebarToggle": true,
    "signInStyle": {
      "icon": "string",
      "label": "string",
      "look": "link",
      "order": "after-ctas",
      "phone": "bar"
    },
    "socialLinks": [
      {
        "href": null,
        "platform": null
      }
    ],
    "sticky": true,
    "subnav": {
      "active": {
        "underline": null,
        "width": null
      },
      "background": "string",
      "backgroundDark": "string",
      "border": "line",
      "endLinks": [
        null
      ],
      "ink": "string",
      "inkDark": "string",
      "justify": "between",
      "links": [
        null
      ],
      "navSize": 0,
      "navWeight": 0,
      "phone": "hide"
    },
    "themeToggle": {
      "activeColor": "string",
      "border": true,
      "footerAlign": "end",
      "hideOn": [
        null
      ],
      "modes": [
        null
      ],
      "phone": "menu",
      "position": "end",
      "radius": 0,
      "show": true,
      "style": "cycle"
    },
    "topBar": {
      "align": "between",
      "background": "string",
      "button": {
        "background": null,
        "ink": null,
        "radius": null
      },
      "case": "capitalize",
      "font": "body",
      "height": 0,
      "ink": "string",
      "links": [
        null
      ],
      "phone": "hide",
      "sticky": true,
      "style": "bar",
      "tracking": 0
    },
    "translations": {}
  },
  "contentLocales": [
    {
      "code": "string",
      "label": "string"
    }
  ],
  "extensionOutlets": [
    {
      "extension": "string",
      "minHeight": 0,
      "outlet": "above-main",
      "position": "after"
    }
  ],
  "inSite": {
    "name": "string",
    "slug": "string"
  },
  "languageSwitcher": true,
  "name": "string",
  "previewing": "site",
  "readerThemes": [
    {
      "name": "string",
      "theme": {
        "accentColor": "string",
        "ads": {
          "configJson": null,
          "configVar": null,
          "enabled": null,
          "network": null,
          "publisherId": null,
          "scriptUrl": null,
          "size": null,
          "slotHtml": null,
          "slotId": null
        },
        "announcement": {
          "audience": null,
          "background": null,
          "backgroundDark": null,
          "bleed": null,
          "button": null,
          "dismissible": null,
          "gradient": null,
          "href": null,
          "ink": null,
          "inkDark": null,
          "inset": null,
          "lead": null,
          "level": null,
          "pages": null,
          "phone": null,
          "placement": null,
          "radius": null,
          "release": null,
          "source": null,
          "span": null,
          "style": null,
          "text": null
        },
        "apiOrigins": [
          null
        ],
        "bodyFontFamily": "string",
        "brandName": null,
        "careers": {
          "facts": null,
          "item": null,
          "list": null,
          "look": null,
          "role": null
        },
        "changelog": {
          "archive": null,
          "breakingBadge": null,
          "channelBadge": null,
          "closes": null,
          "columnWidth": null,
          "dateFormat": null,
          "datePlacement": null,
          "dateTone": null,
          "entry": null,
          "entryGap": null,
          "facts": null,
          "filters": null,
          "group": null,
          "gutter": null,
          "gutterWidth": null,
          "header": null,
          "indexWidth": null,
          "languages": null,
          "look": null,
          "prose": null,
          "rail": null,
          "release": null,
          "sections": null,
          "showTags": null,
          "stickyDate": null,
          "tagInk": null,
          "tagOverflow": null,
          "tagStyle": null,
          "typeBadge": null,
          "upgradeNotesFirst": null,
          "versionBadge": null,
          "widget": null
        },
        "chrome": {
          "accountMenu": null,
          "align": null,
          "brandText": null,
          "copyright": null,
          "cta": null,
          "ctas": null,
          "ctaStyle": null,
          "desktopNav": null,
          "footer": null,
          "footerColumns": null,
          "footerDescription": null,
          "footerLinks": null,
          "header": null,
          "headerLinks": null,
          "height": null,
          "logoPhone": null,
          "mobileNav": null,
          "navMenu": null,
          "search": null,
          "searchHideOn": null,
          "searchPlacement": null,
          "searchStyle": null,
          "secondaryCta": null,
          "showSignIn": null,
          "sidebarBrand": null,
          "sidebarToggle": null,
          "signInStyle": null,
          "socialLinks": null,
          "sticky": null,
          "subnav": null,
          "themeToggle": null,
          "topBar": null,
          "translations": null
        },
        "colorScheme": "dark",
        "colorSchemeStrict": true,
        "componentInstalls": [
          null
        ],
        "components": {
          "apiRef": null,
          "button": null,
          "buttonDark": null,
          "byline": null,
          "caption": null,
          "card": null,
          "code": null,
          "codeDark": null,
          "expandable": null,
          "focus": null,
          "hint": null,
          "image": null,
          "input": null,
          "inputDark": null,
          "kbd": null,
          "link": null,
          "list": null,
          "meta": null,
          "popover": null,
          "preview": null,
          "quote": null,
          "radius": null,
          "scrollbar": null,
          "select": null,
          "selection": null,
          "shadow": null,
          "skeleton": null,
          "spacing": null,
          "stepper": null,
          "syntax": null,
          "syntaxDark": null,
          "syntaxTheme": null,
          "table": null,
          "tabs": null
        },
        "contact": {
          "backdrop": null,
          "channels": null,
          "deflect": null,
          "facts": null,
          "form": null,
          "look": null,
          "offices": null,
          "topics": null
        },
        "contentWidth": "full",
        "courses": {
          "access": null,
          "certificate": null,
          "cohort": null,
          "commerce": null,
          "gamification": null,
          "landing": null,
          "lesson": null,
          "list": null,
          "look": null,
          "outline": null,
          "progress": null,
          "social": null,
          "video": null
        },
        "cssSnippets": [
          null
        ],
        "customCss": "string",
        "customFontFamily": "string",
        "customFontUrl": "string",
        "customJs": "string",
        "docs": {
          "api": null,
          "articleAlign": null,
          "articleWidth": null,
          "aside": null,
          "ask": null,
          "blocks": null,
          "editLink": null,
          "feedback": null,
          "frame": null,
          "header": null,
          "homeAt": null,
          "hub": null,
          "issueLink": null,
          "localeFallback": null,
          "localeSwitcher": null,
          "look": null,
          "mobileNav": null,
          "pageActions": null,
          "pageHead": null,
          "pager": null,
          "panel": null,
          "search": null,
          "sections": null,
          "sidebar": null,
          "suggestEdits": null,
          "toc": null,
          "topRule": null,
          "variantSwitcher": null,
          "versionSwitcher": null
        },
        "elementStyles": [
          null
        ],
        "events": {
          "after": null,
          "agenda": null,
          "chips": null,
          "dateTileTone": null,
          "item": null,
          "list": null,
          "look": null,
          "page": null,
          "series": null,
          "speakers": null,
          "tones": null
        },
        "faq": {
          "audience": null,
          "categories": null,
          "contact": null,
          "featured": null,
          "follow": null,
          "item": null,
          "jump": null,
          "list": null,
          "look": null,
          "search": null
        },
        "faviconUrl": "string",
        "font": "mono",
        "fontOrigins": [
          null
        ],
        "fontOriginsRemoved": [
          null
        ],
        "fonts": {
          "display": null,
          "faces": null
        },
        "footnotes": {
          "placement": null,
          "rule": null
        },
        "forum": {},
        "frameOrigins": [
          null
        ],
        "headingAnchors": "always",
        "headingFontFamily": "string",
        "i18n": {
          "labels": null,
          "switcher": null,
          "urlStyle": null
        },
        "imgOrigins": [
          null
        ],
        "layout": {
          "background": null,
          "canvas": null,
          "floatRoom": null,
          "frame": null,
          "guides": null,
          "gutter": null,
          "heroDecor": null,
          "indexHeader": null,
          "measure": null,
          "widths": null
        },
        "legal": {
          "date": null,
          "definitions": null,
          "docNav": null,
          "facts": null,
          "gloss": null,
          "head": null,
          "history": null,
          "item": null,
          "list": null,
          "look": null,
          "numbering": null,
          "register": null,
          "subprocessors": null,
          "summary": null,
          "trust": null,
          "upcoming": null,
          "variants": null
        },
        "logoDarkMode": "invert",
        "logoIncludesName": true,
        "logoMark": "string",
        "logoUrl": "string",
        "logoUrlDark": "string",
        "logoUrlLight": "string",
        "mediaOrigins": [
          null
        ],
        "mobile": {
          "css": null,
          "density": null,
          "fontScale": null,
          "hide": null,
          "logoUrl": null
        },
        "monoFontFamily": "string",
        "motion": {
          "ambient": null,
          "easing": null,
          "enabled": null,
          "header": null,
          "hover": null,
          "keyframes": null,
          "pageCrossfade": null,
          "pageTransition": null,
          "preset": null,
          "respectReducedMotion": null,
          "reveal": null,
          "scroll": null,
          "speed": null,
          "targets": null
        },
        "notFound": {
          "body": null,
          "hidePage": null,
          "hideSearch": null,
          "links": null,
          "pageId": null,
          "pageSpaceId": null,
          "redirect": null,
          "showSearch": null,
          "showSections": null,
          "title": null
        },
        "onThisPage": "always",
        "palette": {
          "background": null,
          "danger": null,
          "footer_background": null,
          "footer_primary": null,
          "header_background": null,
          "header_primary": null,
          "heading": null,
          "highlight": null,
          "info": null,
          "ink": null,
          "line": null,
          "love": null,
          "muted": null,
          "paper": null,
          "primary": null,
          "quaternary": null,
          "secondary": null,
          "success": null,
          "surface": null,
          "tertiary": null,
          "tint": null,
          "warning": null
        },
        "paletteDark": {
          "background": null,
          "danger": null,
          "footer_background": null,
          "footer_primary": null,
          "header_background": null,
          "header_primary": null,
          "heading": null,
          "highlight": null,
          "info": null,
          "ink": null,
          "line": null,
          "love": null,
          "muted": null,
          "paper": null,
          "primary": null,
          "quaternary": null,
          "secondary": null,
          "success": null,
          "surface": null,
          "tertiary": null,
          "tint": null,
          "warning": null
        },
        "post": {
          "after": null,
          "align": null,
          "authorCard": null,
          "bodyGap": null,
          "breadcrumb": null,
          "breadcrumbStyle": null,
          "byline": null,
          "byTag": null,
          "cover": null,
          "dropCap": null,
          "footnotesPosition": null,
          "header": null,
          "layout": null,
          "masthead": null,
          "offset": null,
          "paddingTop": null,
          "pageActions": null,
          "rail": null,
          "seriesNav": null,
          "share": null,
          "split": null,
          "suggested": null,
          "toc": null
        },
        "primaryColor": "string",
        "primaryColorDark": "string",
        "roadmap": {
          "card": null,
          "filters": null,
          "header": null,
          "item": null,
          "lanes": null,
          "look": null,
          "submit": null,
          "vote": null,
          "width": null
        },
        "scriptOrigins": [
          null
        ],
        "settings": {},
        "settingsSchema": [
          null
        ],
        "showLanguageSwitcher": true,
        "status": {
          "banner": null,
          "bars": null,
          "colors": null,
          "components": null,
          "header": null,
          "hero": null,
          "history": null,
          "incident": null,
          "incidents": null,
          "legend": null,
          "look": null,
          "maintenance": null,
          "metrics": null,
          "page": null,
          "partners": null,
          "uptime": null,
          "widget": null
        },
        "stringOverrides": {},
        "titleBand": {
          "above": null,
          "blend": null,
          "height": null,
          "heightPhone": null,
          "layers": null,
          "layersDark": null,
          "pages": null,
          "titleColor": null,
          "titleColorDark": null
        },
        "typography": {
          "baseSize": null,
          "bodyWrap": null,
          "features": null,
          "fluid": null,
          "headingTransform": null,
          "headingWrap": null,
          "levels": null,
          "numerals": null,
          "opticalSizing": null,
          "rhythm": null,
          "scale": null,
          "ui": null,
          "variation": null
        },
        "whiteLabel": true
      }
    }
  ],
  "redirects": [
    {
      "from": "string",
      "match": {
        "query": null
      },
      "passQuery": true,
      "status": 301,
      "to": "string",
      "type": "redirect"
    }
  ],
  "theme": {},
  "themeComponents": [
    {
      "css": "string",
      "id": "string",
      "outlets": {
        "above-main": {},
        "below-main": {},
        "blog-index-above-list": {},
        "blog-post-after": {},
        "blog-post-before": {},
        "blog-post-end": {},
        "careers-above-list": {},
        "category-header": {},
        "changelog-above-list": {},
        "courses-above-list": {},
        "courses-certificate-footer": {},
        "courses-landing-hero-after": {},
        "courses-lesson-above-body": {},
        "courses-lesson-after-body": {},
        "docs-page-footer": {},
        "docs-page-header": {},
        "docs-sidebar-end": {},
        "docs-sidebar-start": {},
        "events-above-list": {},
        "events-card-footer": {},
        "events-page-above-body": {},
        "events-page-after-body": {},
        "events-page-aside": {},
        "faq-above-list": {},
        "footer-after": {},
        "footer-before": {},
        "forum-categories-above": {},
        "forum-index-above-list": {},
        "forum-index-below-list": {},
        "forum-post-after-body": {},
        "forum-post-author-after": {},
        "forum-sidebar-bottom": {},
        "forum-sidebar-top": {},
        "forum-topic-above-title": {},
        "forum-topic-below-first-post": {},
        "forum-topic-below-title": {},
        "forum-topic-bottom": {},
        "forum-topic-row-after-title": {},
        "front-page-bottom": {},
        "front-page-top": {},
        "header-after": {},
        "header-before": {},
        "roadmap-above-board": {},
        "status-above-board": {},
        "user-card": {}
      },
      "settings": {},
      "slug": "string",
      "strings": {},
      "values": {}
    }
  ],
  "themeDraftApplied": true,
  "translations": {},
  "type": "BLOG",
  "whiteLabel": true
}
Schema
analyticsobjectrequired
Show child parameters
customHeadstring
fathomstring
ga4string
gtmstring
intercomstring
matomostring
matomoHoststring
plausiblestring
plausibleHoststring
posthogstring
posthogHoststring
segmentstring
simpleAnalyticsstring
umamistring
umamiHoststring
announcementSpaceAnnouncementrequired
Show child parameters
audiencestring
all | signedIn | signedOut
backgroundstring
backgroundDarkstring
bleedboolean
buttonobject
Show child parameters
labelstringrequired
dismissibleboolean
gradientobject
Show child parameters
anglenumber
stopsobject[]required
typestringrequired
linear | radial
hrefstring
inkstring
inkDarkstring
insetboolean
leadstring
levelstring
danger | info | warning
pagesstring[]
phonestring
full | lead
placementstring
above-header | below-header
radiusnumber
releaseobject
Show child parameters
fallbackstring
hide | text
maxAgeDaysnumber
onlystring
any | boosted
spaceIdstring
sourcestring
latest-release | text
spanstring
content | page
stylestring
bar | inline
textstringrequired
chatWidgetsWidgetDescriptor[]required
Show child parameters
connectOriginsstring[]required
consentstringrequired
analytics | functional | marketing
originstringrequired
placementstringrequired
anywhere | custom-domain-only
providerIdstringrequired
providerNamestringrequired
scriptstringrequired
srcstring
themeobjectrequired
chromeobjectrequired
Show child parameters
accountMenuobject
Show child parameters
bellboolean
itemsstring | object[]
showAvatarboolean
showNameboolean
alignstring
center | left | split
brandTextstring | object
copyrightstring
ctaobject
Show child parameters
audiencestring
all | signedIn | signedOut
backgroundstring
borderstring
borderDarkstring
fontSizenumber
heightnumber
hrefstringrequired
iconstring
inkstring
inkDarkstring
labelstringrequired
phonestring
bar | menu
showOnPhoneboolean
sizestring
lg | md | sm
ctasChromeCtaItem[]
Show child parameters
actionstring
signIn | signUp
audiencestring
all | signedIn | signedOut
backgroundstring
borderstring
borderDarkstring
fontSizenumber
heightnumber
hrefstringrequired
iconstring
inkstring
inkDarkstring
labelstringrequired
phonestring
bar | menu
showOnPhoneboolean
sizestring
lg | md | sm
stylestring
link | outline | pill | solid | subtle
underlineboolean
ctaStylestring
link | outline | pill | solid | subtle
desktopNavstring
inline | menu
footerobject
Show child parameters
artobject
backgroundobject
borderboolean
bottomAlignstring
columns | frame
bottomRuleboolean
bottomSizenumber
brandPlacementstring
bottom | none | side | top
brandWidthstring | number
breadcrumbboolean
breadcrumbPlacementstring
bottom | top
columnRuleboolean
columnsnumber | string
columnWidthnumber
contentWidthstring
cookieLinkPlacementstring
bottom | brand | columns
cssstring
fontstring
body | heading | mono
headingFontstring
body | heading | mono
headingGapnumber
headingInkstring
headingInkDarkstring
headingSizenumber
headingStylestring
label | plain
headingWeightnumber
hideOnstring[]
htmlstring
htmlLinkInkstring
htmlLinkInkDarkstring
htmlLinkUnderlineboolean
htmlPlacementstring
above | below | replace
htmlSizenumber
layoutstring
rows | stack
linkGapnumber
linkInkstring
linkInkDarkstring
linkSeparatorstring
dot | none | pipe | slash
linkSizenumber
linkWeightnumber
logostring | boolean
logoMarkstring | boolean
newsletterobject
paddingobject
phonestring
accordion | stack
schemestring
dark | light
showBrandNameboolean
socialSizenumber
socialStylestring
circle | plain | square
statusobject
widthstring
footerColumnsobject[]
Show child parameters
audiencestring
all | signedIn | signedOut
headingstringrequired
linksobject[]required
stackboolean
footerDescriptionstring
footerLinksobject[]
Show child parameters
audiencestring
all | signedIn | signedOut
hrefstringrequired
labelstringrequired
headerobject
Show child parameters
accentTopobject
activeMatchstring
auto | explicit
activeStylestring
pill | text | underline
backgroundobject
blurnumber
borderstring | object
borderColorstring
borderSpanstring
bar | group
brandPrefixobject
brandSizenumber | object
controlsAlignstring
end | inline
ctaDividerboolean
floatingobject
groupobject
groupOnScrollstring
full
heightnumber | object
iconSizenumber | object
linksAlignstring
after-search | center | end | start
logoHeightnumber | object
logoHrefstring
maxLinksnumber
menuButtonobject
navCasestring
capitalize | lowercase | none | uppercase
navFontstring
body | heading | mono
navGapnumber
navInkstring
navInkDarkstring
navSeparatorstring
navSizenumber
navTrackingnumber
navWeightnumber
opacitynumber
orderstring[]
overlayboolean
overlayInkstring
paintstring
brand | page
phoneLayoutstring
row | stacked
scrollTitleboolean | string
400 The request could not be understood — a malformed header, path or query value (request.malformed). A value that was understood but is not acceptable is a 422 validation.failed.
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
404 No such thing — one of the ids in the path does not resolve, or resolves to something this caller may not see (*.not_found).
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
429 Rate limited — see the RateLimit-* headers.
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
default Error — the stable { error: { code, message } } envelope.
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
The Forumulate teamUpdated