/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference List Preview Pages

List Preview Pages

The site's own pages that the appearance editor's real-page preview can render

GET/v1/projects/{projectId}/appearance/pagesTry it
Session token

Lists the pages of the project's site that Render Appearance Preview can show — every page of the last production build. The appearance editor fills Your pages, as of your last publish from it.

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
pages:array
One entry per page of the last production build, in build order.
Show 3 child attributesarray

Error Responses

StatusCodeWhen
401unauthorizedNo session token, or an API key
404not_foundThe project doesn't exist, or you're not in its organization
409no_sourceThere's nothing to render from. details.reason is never_built (no production build yet — publish once) or not_captured (the last production build predates real-page previews — publish once more)
json
{
"error": {
"code": "no_source",
"message": "The last build of this project predates page previews. Publish once more, then preview.",
"details": { "reason": "not_captured" }
}
}
Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/appearance/pages \
-H "Authorization: Bearer <session token>"
Responseapplication/json
json
{
"data": {
"pages": [
{ "path": "/", "title": "Acme Docs", "kind": "home" },
{ "path": "/guides/custom-domains", "title": "Custom domains", "kind": "guide" },
{ "path": "/api-reference/domains/create", "title": "Create a domain", "kind": "api" },
{ "path": "/changelog", "title": "Changelog", "kind": "changelog" }
]
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext