A brand's theme
curl --request GET \
--url http://localhost:3000/api/v1/brands/{slug}/theme \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/api/v1/brands/{slug}/theme"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/api/v1/brands/{slug}/theme', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/brands/{slug}/theme",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/brands/{slug}/theme"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api/v1/brands/{slug}/theme")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/brands/{slug}/theme")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"brand": "<string>",
"settings": {
"accent": "<string>",
"accentUse": "fill",
"surface": "<string>",
"panel": "<string>",
"dark": "<string>",
"ink": "<string>",
"muted": "<string>",
"head": "<string>",
"body": "<string>",
"label": "<string>",
"logo": "<string>",
"device": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"radius": 20,
"width": "narrow",
"density": "compact",
"scale": 1.3425,
"nav": "sidebar",
"band": true,
"header": "plain",
"separation": "space",
"numbering": true,
"motion": "none",
"toc": "side",
"languages": [
{
"code": "<string>",
"label": "<string>",
"dir": "ltr"
}
]
},
"theme": {
"v1": {},
"surface": "<string>",
"panel": "<string>",
"dark": "<string>",
"ink": "<string>",
"muted": "<string>",
"onDark": "<string>",
"mutedOnDark": "<string>",
"accent": "<string>",
"accentText": "<string>",
"onAccent": "<string>",
"accentUse": "fill",
"line": "<string>",
"faces": {
"head": {
"family": "<string>",
"weight": 123,
"file": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"files": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"mime": "<string>"
}
],
"fallback": "<string>",
"google": true
},
"body": {
"family": "<string>",
"weight": 123,
"file": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"files": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"mime": "<string>"
}
],
"fallback": "<string>",
"google": true
},
"label": {
"family": "<string>",
"case": "<string>",
"tracking": 123,
"weight": 123,
"file": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"files": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"mime": "<string>"
}
],
"fallback": "<string>",
"google": true
}
},
"radius": 123,
"width": "narrow",
"density": "compact",
"scale": 123,
"device": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"logo": {
"key": "<string>"
},
"nav": "sidebar",
"band": true,
"header": "plain",
"separation": "space",
"numbering": true,
"motion": "none",
"toc": "side",
"checks": [
{
"pair": "<string>",
"fg": "<string>",
"bg": "<string>",
"ratio": 123,
"need": 123,
"ok": true,
"used": "<string>"
}
]
},
"checks": [
{
"pair": "<string>",
"fg": "<string>",
"bg": "<string>",
"ratio": 123,
"need": 123,
"ok": true,
"used": "<string>"
}
],
"warnings": [
"<string>"
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}API Reference
A brand's theme
How its pages look beyond what the rules say: which rule plays which part (accent, surface, ink, faces, logo) and the page’s measure, rhythm and chrome, with the look they give. Every ink is graded on its ground in checks: a pair under its need (4.5:1 for text, 3:1 for marks) falls back to a color that reads and is a warning. So is a setting whose rule has gone since, and the default is used.
Scope: read.
GET
/
api
/
v1
/
brands
/
{slug}
/
theme
A brand's theme
curl --request GET \
--url http://localhost:3000/api/v1/brands/{slug}/theme \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/api/v1/brands/{slug}/theme"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/api/v1/brands/{slug}/theme', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/brands/{slug}/theme",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/brands/{slug}/theme"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api/v1/brands/{slug}/theme")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/brands/{slug}/theme")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"brand": "<string>",
"settings": {
"accent": "<string>",
"accentUse": "fill",
"surface": "<string>",
"panel": "<string>",
"dark": "<string>",
"ink": "<string>",
"muted": "<string>",
"head": "<string>",
"body": "<string>",
"label": "<string>",
"logo": "<string>",
"device": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"radius": 20,
"width": "narrow",
"density": "compact",
"scale": 1.3425,
"nav": "sidebar",
"band": true,
"header": "plain",
"separation": "space",
"numbering": true,
"motion": "none",
"toc": "side",
"languages": [
{
"code": "<string>",
"label": "<string>",
"dir": "ltr"
}
]
},
"theme": {
"v1": {},
"surface": "<string>",
"panel": "<string>",
"dark": "<string>",
"ink": "<string>",
"muted": "<string>",
"onDark": "<string>",
"mutedOnDark": "<string>",
"accent": "<string>",
"accentText": "<string>",
"onAccent": "<string>",
"accentUse": "fill",
"line": "<string>",
"faces": {
"head": {
"family": "<string>",
"weight": 123,
"file": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"files": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"mime": "<string>"
}
],
"fallback": "<string>",
"google": true
},
"body": {
"family": "<string>",
"weight": 123,
"file": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"files": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"mime": "<string>"
}
],
"fallback": "<string>",
"google": true
},
"label": {
"family": "<string>",
"case": "<string>",
"tracking": 123,
"weight": 123,
"file": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"files": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"mime": "<string>"
}
],
"fallback": "<string>",
"google": true
}
},
"radius": 123,
"width": "narrow",
"density": "compact",
"scale": 123,
"device": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"logo": {
"key": "<string>"
},
"nav": "sidebar",
"band": true,
"header": "plain",
"separation": "space",
"numbering": true,
"motion": "none",
"toc": "side",
"checks": [
{
"pair": "<string>",
"fg": "<string>",
"bg": "<string>",
"ratio": 123,
"need": 123,
"ok": true,
"used": "<string>"
}
]
},
"checks": [
{
"pair": "<string>",
"fg": "<string>",
"bg": "<string>",
"ratio": 123,
"need": 123,
"ok": true,
"used": "<string>"
}
],
"warnings": [
"<string>"
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}