API Reference Get Appearance
Get Appearance
Read a project's resolved doc engine v2 appearance, where each value came from, and the raw config it was read from
Session token
Returns the project's appearance resolved exactly the way the next build will
resolve it — the preset, appearance, organization theme and v1 features
flags — with the source of every value, any problems, the raw keys from the
config file, and the site's brand (name, logo and favicon). This is what the appearance editor
opens with.
Any member of the project's organization can call it. It needs a session
token; API keys get 401. A caller outside the organization gets 404.
Path Parameters
NameDescription
projectIdThe project ID.
Response
NameDescription
v2Whether the site renders with doc engine v2 — see Opting in.
appearanceEvery resolved field:
preset, accent ({ light, dark }), mode, toggle, fonts, size, density, radius, width, layout, components, illustrations. layout.home is deprecated — the generated home ended on 16 November 2026, and it's ignored.sourcesWhere each value came from, by path (
"accent.light", "layout.nav", …): preset, legacy-theme, feature-flag, org-theme or appearance.issues{ path, severity, message } for anything the build would warn about or reject. severity is warning or error. A config that can't be read or parsed adds an issue at path: "file".orgThemePresent when
theme names an organization theme that resolved: { ref, slug, version, pinned }.rawThe config's own
theme, appearance, themeOverrides, colors, fonts, features, name, logo and favicon values, null where absent.file{ path, branch, commit } — the config file in the repository and the latest commit that touched it (commit is null when the file doesn't exist yet). null for a project without a repository. Send commit back as baseCommit when publishing.hostedtrue for a project without a repository — its settings are saved in Syntext.brandThe name, logo and favicon as the build will use them, and where each came from.
Show 4 child attributesobject
nameThe site name: the config's
name, else the project settings', else the project name.logo{ light, dark, type }. light and dark are URLs or null; type is mark or wordmark. A single-URL logo comes back as light.faviconThe favicon URL.
sources{ name, logo, favicon }, each config (the repository's config file), settings (the project settings — where a project without a repository keeps them) or project (nothing set: the project name, and the Syntext mark for a null logo or favicon).Response
sources is abbreviated here; it has an entry for every field.
Error Responses
| Status | Code | When |
|---|---|---|
| 401 | unauthorized | No session token, or an API key |
| 404 | not_found | The project doesn't exist, or you're not in its organization |
Related
Was this page helpful? Yes No
Previous
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/appearance \
-H "Authorization: Bearer <session token>"
const response = await fetch('https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/appearance', {
method: 'GET',
headers: {
'Authorization': 'Bearer <session token>',
},
});
const data = await response.json();
console.log(response.status, data);
import requests
url = "https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/appearance"
headers = {
"Authorization": "Bearer <session token>",
}
response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json())
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/appearance", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <session token>")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status)
fmt.Println(string(body))
}
require "net/http"
require "uri"
uri = URI("https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/appearance")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <session token>"
response = http.request(request)
puts response.code
puts response.body
<?php
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => 'https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/appearance',
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <session token>',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);
echo $status, PHP_EOL, $response, PHP_EOL;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/appearance"))
.header("Authorization", "Bearer <session token>")
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
using System.Net.Http;
using System.Text;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/appearance");
request.Headers.TryAddWithoutValidation("Authorization", "Bearer <session token>");
using var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
Responseapplication/json
json
{
"data": {
"v2": true,
"appearance": {
"preset": "paper",
"accent": { "light": "#0E7A63", "dark": "#3DDC97" },
"mode": "system",
"toggle": true,
"fonts": { "heading": "Figtree", "body": "Figtree", "mono": "IBM Plex Mono" },
"size": 16,
"density": "comfortable",
"radius": "large",
"width": "contained",
"layout": { "shell": "sheet", "header": "pill", "home": "pill", "nav": "pills", "toc": "pills", "groups": "collapsible" },
"components": { "callout": "tag", "steps": "cards", "code": "light", "cards": "tile", "tabs": "pill", "api": "card" },
"illustrations": true
},
"sources": { "accent.light": "preset", "accent.dark": "appearance", "mode": "appearance" },
"issues": [],
"raw": {
"theme": "paper",
"appearance": { "accent": { "dark": "#3DDC97" }, "mode": "system" },
"themeOverrides": null,
"colors": null,
"fonts": null,
"features": null,
"name": "Acme Docs",
"logo": { "light": "https://api.syntext.dev/v1/brand-assets/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/3f9a1c2b7d4e.svg", "type": "wordmark" },
"favicon": null
},
"file": { "path": "syntext.json", "branch": "main", "commit": "4f1c2a9" },
"hosted": false,
"brand": {
"name": "Acme Docs",
"logo": { "light": "https://api.syntext.dev/v1/brand-assets/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/3f9a1c2b7d4e.svg", "dark": null, "type": "wordmark" },
"favicon": null,
"sources": { "name": "config", "logo": "config", "favicon": "project" }
}
}
}