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

List Projects

List the projects you can access, optionally with each one's latest build, domain and access mode.

GET/v1/projectsTry it
Session token

Returns the documentation projects in your workspaces, newest first. Add include to get each project's latest build, custom domain and site access mode in the same request.

Note

Any signed-in user, with a session JWT. API keys are not accepted. Any plan. You only see projects of workspaces you are a member of.

Query Parameters

NameDescription
orgId:stringquery
Only projects of this workspace. You must be a member, or the request returns 403 forbidden. Without it, you get the projects of every workspace you belong to.
include:stringquery
Comma-separated extras to attach to each project: lastBuild, domain, access. Any other value returns 400 validation_error. Without include, the response has no extra fields.

The list is not paginated: every matching project is returned.

Response

NameDescription
data:array
Project objects, each with docsUrl and the workspace's plan (free when it has no subscription). With include, each project also has:
Show 4 child attributesarray

Response — 200 OK

Build objects are shortened here. They carry every field listed on Get Build except logs.

Error Responses

Statuserror.codeWhen
400validation_errorinclude contains an unknown value. details.include lists the accepted ones
401unauthorizedNo session JWT, an invalid or expired one, or an API key
401session_revokedThe session has been signed out
403forbiddenYou are not a member of the workspace named by orgId

400 Bad Request

json
{
"error": {
"code": "validation_error",
"message": "Unknown include \"customDomain\"",
"details": {
"include": ["lastBuild", "domain", "access"],
"traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10"
}
}
}
Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl "https://api.syntext.dev/v1/projects?include=lastBuild,domain,access" \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
200OK
{
"data": [
{
"id": "3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c",
"orgId": "org_abc123",
"name": "API Docs",
"slug": "api-docs",
"description": "Documentation for our REST API",
"repoUrl": "https://github.com/acme/api-docs",
"repoBranch": "main",
"customDomain": null,
"subdomain": "api-docs-docs",
"docsUrl": "https://docs.example.com",
"plan": "pro",
"createdAt": "2026-01-15T12:00:00Z",
"updatedAt": "2026-06-28T11:00:00Z",
"lastBuild": {
"id": "bld_abc456",
"status": "failed",
"trigger": "push",
"branch": "main",
"isPreview": false,
"commitSha": "f6e5d4c3b2a1f6e5d4c3b2a1f6e5d4c3b2a1f6e5",
"commitMessage": "Restructure quickstart",
"error": "MDX compilation failed",
"createdAt": "2026-11-08T09:00:00Z",
"completedAt": "2026-11-08T09:00:06Z",
"triggeredByUserId": "usr_abc123",
"triggeredBy": {
"id": "usr_abc123",
"name": "Ada Lovelace",
"avatarUrl": "https://avatars.githubusercontent.com/u/1234567"
},
"errors": [
{
"timestamp": "2026-11-08T09:00:05Z",
"level": "error",
"message": "docs/quickstart.mdx: Unexpected closing tag </Steps>",
"stage": "compiling"
}
],
"progress": null
},
"lastDeployedBuild": {
"id": "bld_xyz789",
"status": "deployed",
"trigger": "push",
"branch": "main",
"isPreview": false,
"deployUrl": "https://api-docs-docs.syntext.dev",
"completedAt": "2026-11-07T10:00:05Z",
"triggeredByUserId": null,
"triggeredBy": null
},
"domain": {
"domain": "docs.example.com",
"status": "ssl_active",
"verified": true
},
"accessMode": "public"
}
]
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext