Projects API

Endpoints for retrieving project configuration and metadata.

Projects API

The API is not yet live. Endpoint paths below are illustrative and subject to change.

Overview

The Projects API allows you to retrieve configuration and metadata for your Traceway projects programmatically. Create and manage projects through the Traceway platform — project creation is not available via API.

Get project

[PLACEHOLDER: Confirm exact endpoint path, e.g. GET /v1/projects/:id or GET /v1/projects/:slug]

Response:

[PLACEHOLDER: Confirm response shape. Expected:]

{
  "id": "proj_abc123",
  "name": "My App",
  "slug": "my-app",
  "isPublic": false,
  "defaultBranch": "main",
  "createdAt": "2026-01-15T09:00:00Z"
}

SDK config endpoint

[PLACEHOLDER: Confirm whether a dedicated SDK config endpoint exists — e.g. GET /v1/sdk/config — that the SDK calls on initialization to fetch project settings, minimum SDK version enforcement, and feature flags. Document if it exists.]

Project statistics

[PLACEHOLDER: Confirm whether a stats endpoint exists — e.g. GET /v1/projects/:id/stats — and what fields it returns (open issue count, total reports, etc.).]

← Previous

Issues

Error Reference