API Reference
Initiatives
Authorization
apiKey AuthorizationBearer <token>
Workspace scoped API key, printed once by pnpm seed or POST /api-keys.
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/initiatives"{ "initiatives": [ { "id": "string", "name": "string", "description": "string", "status": "planned", "lead": { "id": "string", "name": "string", "email": "user@example.com" }, "targetDate": "string", "projects": [ { "id": "string", "name": "string", "status": "string" } ] } ]}Authorization
apiKey AuthorizationBearer <token>
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
curl -X POST "https://example.com/initiatives" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "initiative": { "id": "string", "name": "string", "status": "string" }}Authorization
apiKey AuthorizationBearer <token>
Workspace scoped API key, printed once by pnpm seed or POST /api-keys.
In: header
Path Parameters
id*string
Initiative id
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 PATCH "https://example.com/initiatives/string" \ -H "Content-Type: application/json" \ -d '{}'{ "initiative": { "id": "string", "name": "string", "description": "string", "status": "string", "leadId": "string", "targetDate": "string" }}Authorization
apiKey AuthorizationBearer <token>
Workspace scoped API key, printed once by pnpm seed or POST /api-keys.
In: header
Path Parameters
id*string
Initiative id
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/initiatives/string/page-data"{ "initiative": { "id": "string", "leadId": "string" }}