Skip to content

Export the brand as design tokens

GET
/api/v1/brand/tokens
curl --request GET \
--url 'http://localhost:3000/api/v1/brand/tokens?format=css&fonts=none' \
--header 'Authorization: Bearer <token>'

Colors, numbers, fonts and the type scale as code. css: custom properties on :root, with @font-face for every font file. scss, less: the same as Sass or Less variables. tailwind: a Tailwind 4 @theme; tailwind3: theme.extend for tailwind.config.js. ts: one typed object. shadcn: shadcn/ui’s variables; mui: a Material UI createTheme; chakra: a Chakra UI 3 system. json: W3C Design Tokens (DTCG 2025.10), grouped by key, for Style Dictionary, Tokens Studio or a Figma importer; font files are under $extensions. designmd: DESIGN.md for coding agents, the tokens as YAML front matter and the guidance as prose. A rule set in one of the brand’s fonts aliases it. Sentences and do/don’t lists are guidance, not tokens, and are left out of every format but designmd.

Scope: read.

format
string
default: css
Allowed values: css scss less tailwind tailwind3 ts shadcn mui chakra json designmd designsystem

The output

brand
string

A brand’s slug; the default brand without it

context
string

Resolve for this context, e.g. dark-background

version
string

Live: the release readers see, as a site built from the brand shows it; a number: that release. The draft without it

fonts
string
Allowed values: none

None: leave out the @font-face rules, for a site that serves its own font files

The tokens, as text: CSS, Sass, Less, JS, TypeScript or JSON

An error

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