Skip to content

Section templates

GET
/api/v1/brand/templates
curl --request GET \
--url http://localhost:3000/api/v1/brand/templates \
--header 'Authorization: Bearer <token>'

What a brand page is built from: each template’s use, what its keys may name, what its items are, its layout defaults, its own props as JSON Schema and an example section. common says what every section takes. The MCP tool list_templates serves the same.

Scope: read.

The templates

Media typeapplication/json
object
data
required
object
templates
required
Array<object>
object
template
required
string
name
required
string
use
required

What it is for

string
binds
required

What its keys may name; null: it binds no rules

string | null
items
required

What its items are; null: it takes none

string | null
defaults
required
object
width
required
string
Allowed values: text wide full
columns
required
integer
>= -9007199254740991 <= 9007199254740991
tone
required
string
props
required

Its own settings, as JSON Schema

object
key
additional properties
example
required

A section using it, as PUT takes it

object
key
additional properties
common
required

What every section takes besides its props

string
Example
{
"data": {
"templates": [
{
"defaults": {
"width": "text"
}
}
]
}
}

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"detail": "example"
}
}