Read the roadmap of a project (tenant:forge:read)
GET /api/forge/v1/projects/{key}/roadmap
Module: Forge · operationId: getForgeProjectRoadmap · Tag: Metrics · Auth: access token (Authorization: Bearer <accessToken>)
Requires tenant:forge:read and a project the caller sees. The milestones with their progress and the items of a type with level 1 or higher that have a start date, a due date or a milestone, ordered by start (else due date), then rank; at most 500 (truncated tells there are more).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
key |
path | string | yes | Project key (e.g. APP) |
Responses
- 200 The roadmap (
application/json) - 404 Error (
application/json)
Fields of the 200 answer:
items(array of RoadmapItem, required): Planned items: types of level 1 or higher with dates or a milestone (at most 500)dueOn(string (date), nullable, required): Due dateid(string (uuid), required): Item idmilestoneId(string (uuid), nullable, required): Milestone of the itemparentNumber(integer, nullable, required): Number of the parent itemref(string, required): Item referencestartOn(string (date), nullable, required): Planned start datestatusCategory(string, required): Status category (one oftriage,todo,active,on_hold,done,cancelled)statusKey(string, required): Status keytitle(string, required): TitletypeKey(string, required): Item type keytypeLevel(integer, required): Level of the item type
milestones(array of MilestoneView, required): Milestones of the project with their progresstruncated(boolean, required): There were more than 500 items
Example 200 answer:
{
"items": [
{
"dueOn": "2026-12-30",
"id": "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c01",
"milestoneId": null,
"parentNumber": null,
"ref": "APP-1",
"startOn": "2026-09-23",
"statusCategory": "active",
"statusKey": "in_arbeit",
"title": "Self-Service-Bereich für Kunden",
"typeKey": "epic",
"typeLevel": 3
},
{
"dueOn": "2026-11-24",
"id": "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c05",
"milestoneId": "e0a1b2c3-d4e5-4f6a-8b23-0e1f2a3b4c02",
"parentNumber": 1,
"ref": "APP-5",
"startOn": "2026-10-14",
"statusCategory": "active",
"statusKey": "in_arbeit",
"title": "Ticketübersicht mit Filtern",
"typeKey": "story",
"typeLevel": 2
}
],
"milestones": [
{
"closedAt": null,
"createdAt": "2026-09-30T13:00:00Z",
"description": "Kunden sehen ihre Tickets mit Filtern, Seitenwechseln und einem verständlichen leeren Zustand.",
"dueOn": "2026-11-25",
"id": "e0a1b2c3-d4e5-4f6a-8b23-0e1f2a3b4c02",
"position": 1,
"progress": {
"byCategory": {
"active": 2,
"cancelled": 0,
"done": 5,
"on_hold": 0,
"todo": 2,
"triage": 0
},
"estimate": {
"done": 12,
"total": 25
},
"total": 9
},
"releaseProvider": "github",
"releaseRepo": null,
"releaseTag": null,
"state": "open",
"title": "Version 1.1 – Ticketübersicht",
"updatedAt": "2026-10-21T10:15:00Z",
"version": 2
}
],
"truncated": false
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/forge/v1/projects/string/roadmap' \
-H "Authorization: Bearer $ACCESS_TOKEN"