A brand page
curl --request GET \
--url http://localhost:3000/api/v1/brands/{slug}/pages/{page} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/api/v1/brands/{slug}/pages/{page}"
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}/pages/{page}', 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}/pages/{page}",
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}/pages/{page}"
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}/pages/{page}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/brands/{slug}/pages/{page}")
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>",
"context": "<string>",
"page": {
"slug": "<string>",
"title": "<string>",
"position": 0,
"hidden": true,
"parent": "<string>",
"eyebrow": "<string>",
"lede": "<string>",
"cover": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"icon": "<string>",
"audience": "everyone",
"tabs": true,
"aliases": [
"<string>"
],
"layout": "book",
"updatedAt": "2023-11-07T05:31:56Z",
"sections": [
{
"id": "<string>",
"template": "<string>",
"title": "<string>",
"body": "<string>",
"width": "text",
"columns": 0,
"tone": "<string>",
"hidden": true,
"keys": [
"<string>"
],
"props": {},
"eyebrow": "<string>",
"lede": "<string>",
"aside": "<string>",
"tab": "<string>",
"background": {
"color": "<string>",
"image": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scrim": 123
},
"items": [
{
"key": "<string>",
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"text": "<string>",
"verdict": "do",
"caption": "<string>",
"link": "<string>",
"label": "<string>",
"icon": "<string>",
"download": true
}
],
"audience": "everyone",
"contexts": [
"<string>"
],
"only": "<string>",
"translations": {}
}
],
"translations": {}
},
"rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand": "<string>",
"key": "<string>",
"label": "<string>",
"context": "<string>",
"type": "color",
"value": "<string>",
"spec": {},
"usage": "<string>",
"assets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rendition": "<string>",
"title": "<string>",
"filename": "<string>",
"mime": "<string>",
"width": 0,
"height": 0
}
],
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"missing": [
"<string>"
],
"warnings": [
"<string>"
],
"markdown": "<string>",
"url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}API Reference
A brand page
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.
GET
/
api
/
v1
/
brands
/
{slug}
/
pages
/
{page}
A brand page
curl --request GET \
--url http://localhost:3000/api/v1/brands/{slug}/pages/{page} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/api/v1/brands/{slug}/pages/{page}"
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}/pages/{page}', 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}/pages/{page}",
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}/pages/{page}"
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}/pages/{page}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/brands/{slug}/pages/{page}")
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>",
"context": "<string>",
"page": {
"slug": "<string>",
"title": "<string>",
"position": 0,
"hidden": true,
"parent": "<string>",
"eyebrow": "<string>",
"lede": "<string>",
"cover": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"icon": "<string>",
"audience": "everyone",
"tabs": true,
"aliases": [
"<string>"
],
"layout": "book",
"updatedAt": "2023-11-07T05:31:56Z",
"sections": [
{
"id": "<string>",
"template": "<string>",
"title": "<string>",
"body": "<string>",
"width": "text",
"columns": 0,
"tone": "<string>",
"hidden": true,
"keys": [
"<string>"
],
"props": {},
"eyebrow": "<string>",
"lede": "<string>",
"aside": "<string>",
"tab": "<string>",
"background": {
"color": "<string>",
"image": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scrim": 123
},
"items": [
{
"key": "<string>",
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"text": "<string>",
"verdict": "do",
"caption": "<string>",
"link": "<string>",
"label": "<string>",
"icon": "<string>",
"download": true
}
],
"audience": "everyone",
"contexts": [
"<string>"
],
"only": "<string>",
"translations": {}
}
],
"translations": {}
},
"rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand": "<string>",
"key": "<string>",
"label": "<string>",
"context": "<string>",
"type": "color",
"value": "<string>",
"spec": {},
"usage": "<string>",
"assets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rendition": "<string>",
"title": "<string>",
"filename": "<string>",
"mime": "<string>",
"width": 0,
"height": 0
}
],
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"missing": [
"<string>"
],
"warnings": [
"<string>"
],
"markdown": "<string>",
"url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}Authorizations
bearersession
An API key: ab_...
Query Parameters
Resolve its rules for this context, e.g. dark-background
Response
The page
Show child attributes
Show child attributes