Support / Account, team & billing
API Tokens and the Customer API
API tokens give scripts and integrations access to your company's schedules: pull schedule data into a dashboard or data warehouse, or push percent complete from a field system. There's no separate API plan.
Create a token
Owners and Editors can create tokens.
- Settings → API tokens.
- Enter a Token name that says what it's for, like "Power BI refresh".
- Leave Allow writes ticked if the integration needs to update progress, or untick it for read-only.
- Click Mint token.
Copy the token immediately. It's shown once and can't be retrieved later. If you lose it, revoke it and mint a new one.
A token only works for your organization and has the same project access as the person who created it.
Use a token
Send it as a bearer token over HTTPS with JSON:
Authorization: Bearer aos_...
Accept: application/jsonMain endpoints:
| Method | Path | Purpose |
|---|---|---|
| GET | /api/orgs/{org_id}/projects | List projects |
| GET | /api/orgs/{org_id}/projects/{id} | One project |
| GET | /api/orgs/{org_id}/projects/{id}/schedule/data.json | Full schedule data |
| PATCH | /api/orgs/{org_id}/projects/{id}/schedule/tasks/{task_id} | Update percent complete or remaining duration |
A progress update sends scheduleVersion, percentComplete, and remainingDurationDays. The OpenAPI description is at https://app.schedule.construction/static/customer-api.openapi.json.
Errors
| Code | Meaning |
|---|---|
| 400 | Bad input |
| 401 | Missing or invalid token |
| 402 | The company is read-only for billing |
| 403 | The token's owner can't access that project, or the token is read-only |
| 404 | Not found |
| 409 | The schedule changed since you read it. Re-read and retry |
Don't automatically retry a write that timed out. Read the task first to see whether it was applied.
Revoke a token
Settings → API tokens → Revoke. It stops working immediately. Revoking still works when the company is read-only.