Resources · API

API reference.

TraceWorks API access lets you sync project records with PLM, ERP, CI, and bespoke engineering tooling. The API is in active design — request early access if you'd like to shape it.

Status:Early access — request below

Planned surfaces

What the v1 API will cover

Records

GET / POST / PATCH

Read and write project artifacts: requirements, specifications, products, components, tasks, risks, decisions, submittals.

GET /v1/projects/:projectId/requirements
?status=APPROVED&type=REGULATORY

Trace links

GET / POST / DELETE

Create, inspect, and delete typed traceability links between artifacts. All link writes flow through authorization.

POST /v1/projects/:projectId/trace-links
{
  "sourceType": "Requirement",
  "sourceId":   "req_abc",
  "targetType": "Specification",
  "targetId":   "spec_xyz",
  "kind":       "SATISFIES"
}

Trace Score

GET

Fetch the computed Trace Score for a project, including the per-dimension breakdown and weights applied.

GET /v1/projects/:projectId/trace-score

→ {
  "score": 73,
  "breakdown": [
    { "key": "requirementDefinition", "score": 84, ... }
  ]
}

Webhooks

Outbound

Subscribe to events: requirement approved, change request opened, AI suggestion accepted, trace link created.

POST <your endpoint>
{
  "event":   "requirement.approved",
  "project": "proj_123",
  "actor":   { "userId": "u_456" },
  "data":    { "requirementId": "req_abc" }
}

Want early access?

Tell us what you'd sync and which records matter most. Early-access partners help shape v1.

Request access