API Reference
Projects
Authorization
apiKey AuthorizationBearer <token>
Workspace scoped API key, printed once by pnpm seed or POST /api-keys.
In: header
Query Parameters
initiative?string
Filter to an initiative's projects
Response Body
application/json
application/json
curl -X GET "https://example.com/projects"{ "projects": [ { "id": "string", "name": "string", "description": "string", "status": "backlog", "initiative": { "id": "string", "name": "string" }, "lead": { "id": "string", "name": "string" }, "teams": [ { "id": "string", "key": "string", "name": "string" } ], "startDate": "string", "targetDate": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ]}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
application/json
curl -X POST "https://example.com/projects" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "teams": [ "string" ] }'{ "project": { "id": "string", "name": "string", "description": "string", "status": "backlog", "initiative": { "id": "string", "name": "string" }, "lead": { "id": "string", "name": "string" }, "teams": [ { "id": "string", "key": "string", "name": "string" } ], "startDate": "string", "targetDate": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}Authorization
apiKey AuthorizationBearer <token>
Workspace scoped API key, printed once by pnpm seed or POST /api-keys.
In: header
Path Parameters
id*string
Project 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/projects/string" \ -H "Content-Type: application/json" \ -d '{}'{ "project": { "id": "string", "name": "string", "description": "string", "status": "backlog", "initiative": { "id": "string", "name": "string" }, "lead": { "id": "string", "name": "string" }, "teams": [ { "id": "string", "key": "string", "name": "string" } ], "startDate": "string", "targetDate": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}Authorization
apiKey AuthorizationBearer <token>
Workspace scoped API key, printed once by pnpm seed or POST /api-keys.
In: header
Path Parameters
id*string
Project id
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/projects/string/page-data"{ "project": { "id": "string", "description": "string" }}