get_chrome
Load site header or footer. kind header is the chrome-header design surface and kind footer is chrome-footer. channel=email reads the email template header/footer instead; it has no revision history, so versions, revisionId, and publishStatus apply to the site chrome only. Default mode=summary returns {id,type,propsKeys} per block and sets truncated. mode=full returns the stored tree. propsKeys are the saved top-level keys, including group names and shell. mode=translation-gaps returns per-locale overlay gaps vs primary. blockId returns that block subtree only. A summary is not a write body. Edit with a partial content tree or ops. Ops paths use the nested schema, such as shell.anchor.anchorId. Every response also carries style. The default is the contrast colours only (page background, surface, primary text, and inverse text), plus the dark palette when dual theme is on. includeStyle=true adds fonts, radius, section padding, the container width, and the breakpoints. Use them instead of get_theme; block props still take token paths such as colors.text.primary.
get_chrome · Grup: design
Load site header or footer. kind header is the chrome-header design surface and kind footer is chrome-footer. channel=email reads the email template header/footer instead; it has no revision history, so versions, revisionId, and publishStatus apply to the site chrome only. Default mode=summary returns {id,type,propsKeys} per block and sets truncated. mode=full returns the stored tree. propsKeys are the saved top-level keys, including group names and shell. mode=translation-gaps returns per-locale overlay gaps vs primary. blockId returns that block subtree only. A summary is not a write body. Edit with a partial content tree or ops. Ops paths use the nested schema, such as shell.anchor.anchorId. Every response also carries style. The default is the contrast colours only (page background, surface, primary text, and inverse text), plus the dark palette when dual theme is on. includeStyle=true adds fonts, radius, section padding, the container width, and the breakpoints. Use them instead of get_theme; block props still take token paths such as colors.text.primary.
Girdiler
| Field | Required | Notes |
|---|---|---|
websiteId | required | |
kind | required | |
channel | optional | website (default) reads the site header/footer. email reads the email template header/footer. |
versions | optional | List this many stored revisions of the chrome instead. |
revisionId | optional | Return one stored revision of the chrome instead. |
publishStatus | optional | { path, revisionId }: report whether that revision is the one served for the path. |
contentLocale | optional | |
mode | optional | summary (default) | full | translation-gaps. summary returns ids and saved keys. full returns the stored tree. |
blockId | optional | |
blockType | optional | Summary filter: block type. |
under | optional | Summary filter: this block and its descendants. |
depth | optional | Summary filter: max depth. |
propsKeys | optional | Summary: false returns id and type only. |
includeDefaults | optional | true or annotate. Applies to mode=full. |
shape | optional | grouped (default) | legacy-flat |
includeStyle | optional |
Eşlendiği uçlar
GET /api/v1/{locale}/{websiteId}/chrome/header→ APIGET /api/v1/{locale}/{websiteId}/chrome/footer→ APIGET /api/v1/{locale}/{websiteId}/email-chrome/header→ APIGET /api/v1/{locale}/{websiteId}/email-chrome/footer→ API