Updates
Authorization
apiKey Workspace scoped API key, printed once by pnpm seed or POST /api-keys.
In: header
Query Parameters
Team key (pass exactly one of team, initiative, project)
Initiative name or id
Project name or id
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/updates"{ "updates": [ { "id": "string", "title": "string", "content": "string", "health": "on_track", "createdAt": "2019-08-24T14:15:22Z", "creator": { "name": "string" }, "issues": [ { "identifier": "string", "title": "string" } ] } ]}Health is computed server-side from target date vs. progress; it cannot be set directly.
Authorization
apiKey Workspace scoped API key, printed once by pnpm seed or POST /api-keys.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/updates" \ -H "Content-Type: application/json" \ -d '{ "title": "string", "content": "string" }'{ "update": { "id": "string", "title": "string", "health": "on_track" }}Authorization
apiKey Workspace scoped API key, printed once by pnpm seed or POST /api-keys.
In: header
Query Parameters
Team key (pass exactly one of team, initiative, project)
Initiative name or id
Project name or id
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/updates/candidates"{ "since": { "update": "string", "at": "2019-08-24T14:15:22Z" }, "issues": [ { "identifier": "string", "title": "string", "description": "string", "completedAt": "2019-08-24T14:15:22Z", "assignee": "string", "project": "string", "labels": [ "string" ] } ]}