BuildChart REST API

Authentication

Include your API key in the Authorization header:

curl -H "Authorization: Bearer cg_live_xxxxxxxxxxxx" \
  https://your-domain.com/api/v1/projects

API keys are generated in your account settings after signing up. API access is available on the Business plan.

Rate Limits

API access is available on Business plans. Rate limits are enforced per API key. Exceeding limits returns HTTP 429.

Response headers include X-RateLimit-Limit, X-RateLimit-Remaining, and Retry-After.

Circuit breaker: Keys making 3x their normal rate in any 5-minute window are automatically suspended. Unsuspend from /account/api-keys.

Base URL

Response Format

// Success
{ "data": { ... }, "error": null }

// Error
{ "data": null, "error": "Error message" }

Endpoints

{ "status": "ok", "timestamp": "...", "version": "1.0" }

{ "user_id": "uuid", "scope": "read_write", "profile": {...}, "project_count": 5 }

[{ "id": "uuid", "name": "New Home Build", "start_date": "2026-05-01", ... }]

{ "id": "uuid", "name": "...", "tasks": [...], "members": [...] }

[{ "id": "uuid", "activity": "Framing", "status": "In Progress", ... }]

{ "activity": "Framing", "start_date": "2026-05-04", "end_date": "2026-05-15", "section": "Execution" }

{ "id": "uuid", "activity": "Framing", ... }

{ "status": "Complete", "percent_done": 1 }

{ "id": "uuid", "status": "Complete", ... }

{ "deleted": true }

[{ "user_id": "uuid", "role": "subcontractor", ... }]

{ "entries": [...], "total": 42, "limit": 20, "offset": 0 }

Webhooks

Receive real-time events when things change in BuildChart.

Events

Signature Verification

const crypto = require('crypto');
const signature = req.headers['x-webhook-signature'];
const expected = 'sha256=' + crypto
  .createHmac('sha256', webhookSecret)
  .update(JSON.stringify(req.body))
  .digest('hex');
if (signature !== expected) throw new Error('Invalid signature');

Code Examples

JavaScript / Node.js

const res = await fetch('https://your-domain.com/api/v1/projects', {
  headers: { 'Authorization': 'Bearer cg_live_xxxx' }
});
const { data } = await res.json();
console.log(data); // Array of projects

Python

import requests
headers = {"Authorization": "Bearer cg_live_xxxx"}
r = requests.get("https://your-domain.com/api/v1/projects", headers=headers)
projects = r.json()["data"]