/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
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

GET/v1/projects/{projectId}/appearanceTry it
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
projectId:stringpathRequired
The project ID.

Response

NameDescription
v2:boolean
Whether the site renders with doc engine v2 — see Opting in.
appearance:object
Every 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.
sources:object
Where each value came from, by path ("accent.light", "layout.nav", …): preset, legacy-theme, feature-flag, org-theme or appearance.
issues:array
{ 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".
orgTheme:object
Present when theme names an organization theme that resolved: { ref, slug, version, pinned }.
raw:object
The config's own theme, appearance, themeOverrides, colors, fonts, features, name, logo and favicon values, null where absent.
file:object | null
{ 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.
hosted:boolean
true for a project without a repository — its settings are saved in Syntext.
brand:object
The name, logo and favicon as the build will use them, and where each came from.
Show 4 child attributesobject

Response

sources is abbreviated here; it has an entry for every field.

Error Responses

StatusCodeWhen
401unauthorizedNo session token, or an API key
404not_foundThe project doesn't exist, or you're not in its organization
Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/appearance \
-H "Authorization: Bearer <session token>"
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" }
}
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext