Syntext DOCS
Get Started
API List Builds
GET/v1/projects/{projectId}/builds

List Builds

Returns a paginated list of builds for a project, ordered by most recent first.

Path Parameters

The project ID (e.g., prj_abc123).

Query Parameters

Page number for pagination.

Number of results per page. Maximum: 100.

Filter by build status. One of: queued, building, deployed, failed.

Filter by Git branch name.

Response

Array of build objects.

Build identifier (e.g., bld_abc123).

Build status: queued, building, deployed, failed.

What triggered the build: push, manual, api, github_app.

Git branch that was built.

Git commit SHA.

Git commit message.

Whether this is a preview deployment.

Deployed URL for this build.

Build duration in milliseconds.

ISO 8601 timestamp.

ISO 8601 timestamp when deployment completed.

Example

curl https://api.syntext.dev/v1/projects/prj_abc123/builds \
-H "Authorization: Bearer stx_abc12345_..."
import { Syntext } from '@syntext/sdk'

const client = new Syntext('stx_abc12345_...')
const { data } = await client.builds.list('prj_abc123')
from syntext import Syntext

client = Syntext("stx_abc12345_...")
builds = client.builds.list("prj_abc123")

Response

{
  "data": [
    {
      "id": "bld_xyz789",
      "status": "deployed",
      "trigger": "push",
      "branch": "main",
      "commitSha": "a1b2c3d4e5f6",
      "commitMessage": "Update API documentation",
      "isPreview": false,
      "url": "https://api-docs-docs.syntext.dev",
      "duration": 4523,
      "createdAt": "2026-06-28T10:00:00Z",
      "deployedAt": "2026-06-28T10:00:05Z"
    },
    {
      "id": "bld_abc456",
      "status": "deployed",
      "trigger": "github_app",
      "branch": "feature/new-endpoints",
      "commitSha": "f6e5d4c3b2a1",
      "commitMessage": "Add new endpoints section",
      "isPreview": true,
      "url": "https://dev--api-docs.syntext.dev",
      "duration": 3891,
      "createdAt": "2026-06-27T15:30:00Z",
      "deployedAt": "2026-06-27T15:30:04Z"
    }
  ],
  "pagination": {
    "page": 1,
    "perPage": 20,
    "total": 47,
    "totalPages": 3
  }
}
Assistant
Responses are generated using AI and may contain mistakes.

Ask me anything about the documentation.

ESC