/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Get Project

Get Project

Retrieve a single project by ID

GET/v1/projects/{projectId}Try it
Session token

Retrieve details for a single documentation project.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID (e.g., 3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c).

Response

NameDescription
data:object
The project object.
Show 13 child attributesobject

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
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c \
-H "Authorization: Bearer $SYNTEXT_JWT"
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"
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext