Retrieve details for a single documentation project.
Path Parameters
NameDescription
projectIdThe project ID (e.g.,
3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c).Response
NameDescription
dataThe project object.
Show 13 child attributesobject
idUnique project identifier.
nameProject display name.
slugURL-friendly identifier.
descriptionProject description.
docsUrlLive documentation URL.
customDomainCustom domain if configured.
repoUrlConnected GitHub repository URL.
repoBranchBranch to build from.
contentSourceWhere the project's pages live:
hosted (written in Syntext — see Write and publish without GitHub), github (the connected repository) or upload (published with stx deploy, not stored).githubSyncWhere a move between Syntext and GitHub stands — see Connect GitHub.
null for a project that never used it.Show 14 child attributesobject | null
statepushing (the pages are being sent), pending_merge (a pull request is open; the site keeps publishing from Syntext), linked (GitHub is the source), pr_closed (the pull request was closed without merging; the project stays in Syntext) or failed (see error).strategypush, pull_request or use_repo.repoUrlThe repository.
branchThe branch the pages go to, or the pull request's base.
docsPathThe docs folder in the repository,
"" for its root.installationIdThe GitHub App installation used.
revisionThe Syntext revision the move carried to GitHub;
null when nothing was pushed (use_repo).commitShaThe commit the move made, when it made one.
prBranchThe branch a
pull_request move committed to (syntext/move-from-syntext-<date>).pullRequest{ number, url } of the pull request a pull_request move opened.hostedChangesAfterSynctrue when pages were saved in Syntext after revision, so the repository doesn't hold them. They stay in Syntext's history.errorOn
failed: { code, message, retryAfterSeconds? }. retryAfterSeconds is set when GitHub rate-limited the move.startedAtISO 8601. When the move started.
updatedAtISO 8601. When its state last changed.
settingsProject settings — branding (
logo, colors, navigation, favicon), site password (passwordEnabled), AI (aiPersona, aiRateLimit, support), and settings managed by their own endpoints, such as sso. See Update Project for the keys you can write. Secrets are never returned.Show 2 child attributesobject
hasPasswordWhether a site password is set. The password hash itself is never returned.
sso.hasClientSecretPresent when SSO is configured: whether a client secret is stored. The secret itself is never returned.
createdAtISO 8601 creation timestamp.
updatedAtISO 8601 last update timestamp.
Error Responses
404 Not Found
Returned when the project does not exist.
json
{
"error": {
"code": "not_found",
"message": "Project not found"
}
}
403 Forbidden
Returned when the project exists but you are not a member of the organization that owns it. A session token alone is not enough: access is decided by your membership of the owning org, the same way it is for updating and deleting a project.
json
{
"error": {
"code": "forbidden",
"message": "You do not have access to this project"
}
}
401 Unauthorized
Returned when the session token is missing or invalid. API keys are not accepted here.
json
{
"error": {
"code": "unauthorized",
"message": "Missing or invalid authorization header"
}
}
Was this page helpful? Yes No
Previous
Next
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c \
-H "Authorization: Bearer $SYNTEXT_JWT"
// A browser has no environment variables: set these to your values.
const SYNTEXT_JWT = '<SYNTEXT_JWT>';
const response = await fetch('https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c', {
method: 'GET',
headers: {
'Authorization': `Bearer ${SYNTEXT_JWT}`,
},
});
const data = await response.json();
console.log(response.status, data);
import os
import requests
url = "https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c"
headers = {
"Authorization": f"Bearer {os.environ['SYNTEXT_JWT']}",
}
response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json())
package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest("GET", "https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("SYNTEXT_JWT"))
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/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("SYNTEXT_JWT")}"
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/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c',
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('SYNTEXT_JWT'),
],
]);
$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/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c"))
.header("Authorization", "Bearer " + System.getenv("SYNTEXT_JWT"))
.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/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c");
request.Headers.TryAddWithoutValidation("Authorization", "Bearer " + Environment.GetEnvironmentVariable("SYNTEXT_JWT"));
using var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
Responseapplication/json
json
{
"data": {
"id": "3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c",
"name": "API Docs",
"slug": "api-docs",
"description": "Documentation for our REST API",
"docsUrl": "https://docs.example.com",
"customDomain": "docs.example.com",
"repoUrl": "https://github.com/acme/api-docs",
"repoBranch": "main",
"contentSource": "github",
"githubSync": null,
"settings": {
"colors": { "primary": "#4f46e5" },
"passwordEnabled": true,
"hasPassword": true
},
"createdAt": "2026-01-15T12:00:00Z",
"updatedAt": "2026-01-20T08:30:00Z"
}
}