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

List Previews

List a project's pull-request preview deployments.

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

Returns the project's pull-request previews — one record per pull request, newest first, up to 20.

Note

Any workspace member, with a session JWT. API keys are not accepted. Any plan.

Records are created by the GitHub webhooks when a pull request is opened, synchronized or reopened, and by Create Preview. When the pull request's build finishes, its record moves to deployed (with the URL the preview is served at) or failed.

Path Parameters

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

Response

NameDescription
data:array
Preview records, newest first. At most 20 are returned and there is no pagination.
Show 13 child attributesarray

Error Responses

Statuserror.codeWhen
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 project's workspace
404not_foundThe project does not exist or is deleted
Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/previews \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
200OK
{
"data": [
{
"id": "prv_abc123",
"projectId": "3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c",
"prNumber": 42,
"prTitle": "Document the new endpoints",
"branch": "feature/new-endpoints",
"baseBranch": "main",
"commitSha": "f6e5d4c3b2a1f6e5d4c3b2a1f6e5d4c3b2a1f6e5",
"previewUrl": "https://feature-new-endpoints--api-docs.syntext.dev",
"status": "deployed",
"author": {
"name": "Ada Lovelace",
"login": "ada",
"avatarUrl": "https://avatars.githubusercontent.com/u/1234567"
},
"expiresAt": null,
"createdAt": "2026-11-07T15:30:00Z",
"updatedAt": "2026-11-07T15:31:10Z"
}
]
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext