get_components
Omit componentId to list reusable components for a website. Pass componentId to load one: default mode=summary returns ids and saved keys and sets truncated, mode=full returns the stored tree, mode=detailed adds requests/requestsDetailed, inputSchema, parseErrors, and ComponentBlock inputMappings, mode=mapping returns inputMappings. versions=N lists the component's revisions (newest first) and revisionId returns one stored revision. publishStatus is not available here: a component is served through the pages that embed it, so check those with get_pages. A summary is not a write body. See design/shared-concepts/data-requests. 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_components · Grup: design
Omit componentId to list reusable components for a website. Pass componentId to load one: default mode=summary returns ids and saved keys and sets truncated, mode=full returns the stored tree, mode=detailed adds requests/requestsDetailed, inputSchema, parseErrors, and ComponentBlock inputMappings, mode=mapping returns inputMappings. versions=N lists the component's revisions (newest first) and revisionId returns one stored revision. publishStatus is not available here: a component is served through the pages that embed it, so check those with get_pages. A summary is not a write body. See design/shared-concepts/data-requests. 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 | |
componentId | optional | |
versions | optional | List this many stored revisions instead. |
revisionId | optional | Return one stored revision instead. |
contentLocale | optional | |
mode | optional | summary (default) | full | detailed | mapping | 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 under the root, or under under. |
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}/components→ APIGET /api/v1/{locale}/{websiteId}/components/{id}→ APIPOST /api/v1/{locale}/{websiteId}/design/revisions→ API