API Reference List Preview Pages
List Preview Pages
The site's own pages that the appearance editor's real-page preview can render
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
projectIdThe project ID.
Response
NameDescription
pagesOne entry per page of the last production build, in build order.
Show 3 child attributesarray
pathThe page's path on the site, such as
/ or /guides/custom-domains. Send it as path to Render Appearance Preview.titleThe page title, or its slug when it has none.
kindhome, guide, api or changelog.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 |
| 409 | no_source | There'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" }
}
}
Related
Was this page helpful? Yes No
Previous
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/appearance/pages \
-H "Authorization: Bearer <session token>"
const response = await fetch('https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/appearance/pages', {
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/pages"
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/pages", 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/pages")
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/pages',
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/pages"))
.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/pages");
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": {
"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" }
]
}
}