A brand page
const url = 'http://localhost:3000/api/v1/brands/example/pages/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url http://localhost:3000/api/v1/brands/example/pages/example \ --header 'Authorization: Bearer <token>'The page, the rules its sections show resolved for context, the keys whose rule has gone (missing), what a reader would trip on (warnings), the page as Markdown, and url, where a member reads it in the app. A slug it had before a rename finds it too.
Scope: read.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Brand slug
The page’s slug, e.g. logo
Query Parameters
Section titled “Query Parameters”Resolve its rules for this context, e.g. dark-background
Responses
Section titled “Responses”The page
object
object
object
The page it sits under; null at the top
On portals: who may read it
Its child pages show as tabs across its top
Slugs it had before a rename: they still find it
Landing: a front with no nav column, on-this-page or pager; book: a chapter
The last change to what it says
What it says, as a hash: send it back in If-Match (edit_page and save_page: revision) to refuse a write over a change you haven’t seen
object
GET /api/v1/brand/templates lists them
Markdown
Its ground: plain, tint, brand, panel, dark, color, image or pattern
The rules it shows, by key, in order
Its template’s own settings
object
Markdown
Sections sharing a tab name show under one tab
object
A thing a template lists: a do or a don’t with its picture, a picture in a gallery
object
A rule it shows
Markdown
False: for reference, never offered as a download
A tab per context, its rules resolved for each
Shown only in this context
The rules its sections show, resolved for the context
object
The brand’s slug
Dotted, e.g. color.primary
The heading readers see; null: the key, in words
Null: the default
object
Pixels
400 regular, 700 bold
Assets it points at, in order: /a/{id}, or /a/{id}/{rendition} when it names one
Keys a section shows whose rule has gone since
What a reader would trip on, though it saves: links that go nowhere, keys with no rule
The page as Markdown, its rules’ values filled in
Where a member reads it in the app
Example
{ "data": { "page": { "audience": "everyone", "layout": "book", "sections": [ { "width": "text", "items": [ { "verdict": "do" } ], "audience": "everyone" } ] }, "rules": [ { "type": "color" } ] }}default
Section titled “default”An error
object
object
Examplegenerated
{ "error": { "code": "example", "message": "example", "detail": "example" }}