The plan of a project: its items, milestones, dependencies and findings (desk:read)
GET /api/desk/v1/projects/{id}/plan
Module: Desk · operationId: getProjectPlan · Tag: Projects · Auth: access token (Authorization: Bearer <accessToken>)
Items the caller does not see are left out, and so are dependencies to them. Findings flag delays and conflicts as of today; nothing is moved – reschedule an item with PATCH /items/{ref} (startOn, dueAt) at its version.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | Id or number |
Responses
- 200 Plan (
application/json)
Fields of the 200 answer:
dependencies(array of ItemDependency): Only between visible itemscreatedAt(string (date-time), read-only): When it was createdcreatedBy(string, read-only): Login (e-mail) of who created itid(string, read-only): Id of the dependencykind(string): Kind of dependency (one offinish_to_start)lagDays(integer): Days between the predecessor's end and the successor's start; negative = overlap (max 365)predecessorId(string): Item that has to end firstprojectId(string, read-only): Project of the dependencysuccessorId(string): Starts lagDays after the predecessor ended (finish-to-start)
findings(array of PlanFinding): What the plan flagsdays(integer): By how many days (conflict, late, at_risk)dependencyId(string): Dependency concerneditemId(string): Item concernedkind(string): What the plan flags (one ofconflict,late,blocked,at_risk,milestone_late,undated)milestoneId(string): Milestone concerned
items(array of object): The project's items the caller sees; endOn is the date of the due date (Europe/Berlin)assignees(array of object): People working on the itemendOn(string (date), nullable): End of the itemestimateMinutes(integer, nullable): Estimate in minutesid(string): Id of the itemnumber(integer): Number of the itemparentId(string, nullable): Parent itemphase(string): Phase of the status (one ofnew,active,waiting,done)projectMilestoneId(string, nullable): Milestone of the itemspaceId(string): Space of the itemspentMinutes(integer, nullable): Work HR booked on the ticket; null when HR does not answerstartOn(string (date), nullable): Start of the itemstatus(string): Status keytitle(string): TitletypeId(string): Type of the itemversion(integer): Send it when rescheduling through PATCH /items/{ref}
milestones(array of ProjectMilestone): Milestones of the projectachievedAt(string (date-time), nullable, read-only): When the milestone was reachedachievedBy(string, read-only): The person, or system for completion by itemscompletion(string): manual: achieved by hand; items: reached once all its items are done (and open again when one reopens) (one ofmanual,items)contractId(string, read-only): Contract of a contract batch (empty otherwise)customerId(string, read-only): The invoice's customerdescription(string): Description of the milestonedueOn(string (date)): Due dateid(string, read-only): Id of the milestoneitems(integer, read-only): Visible items of the milestone (plan only)itemsDone(integer, read-only): Visible items of the milestone that are done (plan only)label(string, read-only): The unit as the invoice names it (project, contract, customer name)position(integer): Position among the project's milestonesprojectId(string, read-only): Project of a project batch (empty otherwise)scope(string, read-only): (one ofproject,contract,customer)title(string): Title of the milestone (max length 200)version(integer): Version of the milestone; send it back on change
project(Project)spaceId(string, required): Home space of the project (id or key on input, always the id in responses); must be an active space of the tenant. Required when a project is created; an update without it keeps the stored spacetitle(string, required): Title of the project (max length 200)archived(boolean): Archived: the project is kept for existing data but no longer offered in pickersbudgetAmount(number, nullable): Budget as a net amount (EUR)budgetMinutes(integer, nullable): Time budget; the warning uses itbudgetState(string, read-only): Absent without a time budget or while the spent time is unknown (one ofok,warning,exceeded)createdAt(string (date-time), read-only): When the project was createdcreatedBy(string, read-only): Login (e-mail) of who created the projectcustomFields(object): Values of the type's layout fields, keyed by field key ("cf." optional on input)customer(Ref | null): Masterdata customer of the projectdescription(string): Description of the projectendOn(string (date), nullable): Planned endflatRateArticle(object, nullable): No longer used: flat-rate articles are chosen on HR's work entries (ADR 0040); ignored on write and no longer returnedhourlyRate(number, nullable): No longer used: hourly rates of projects are HR's work rates with the project reference (ADR 0040); ignored on write and no longer returnedid(string, read-only): Id of the projectitemsByPhase(object, read-only): In lists only: the project's tickets by phase (new, active, waiting, done), counted like the project summary (merged tickets left out)number(integer, read-only): Project number, unique in the tenantphase(string, read-only): Phase of the status (one ofnew,active,waiting,done)plannedMinutes(integer, nullable): Planned effort in minutesresponsibleName(string): Name of the person responsibleresponsibleRef(string): Login (e-mail) of the person responsiblespentMinutes(integer, nullable, read-only): Work HR booked with the project as reference (desk:project:<id>, worked minus breaks, ADR 0040); null when HR does not answerstartOn(string (date), nullable): Planned startstatus(string): A status of the type's workflow (default its initial status; changes follow its transitions); without type planned, active, on_hold, done or cancelledticketDisplay(string): How the project's tickets show in the ticket lists and boards:ticketsas ordinary tickets,projectsonly on the projects page,hiddennot in the lists (unless assigned to the viewer). An update without it keeps the stored value (one oftickets,projects,hidden; default"tickets")typeId(string, nullable): Project type (id or key on input); null: the built-in statuses and no custom fieldsupdatedAt(string (date-time), read-only): When the project was last changedupdatedBy(string, read-only): Login (e-mail) of who last changed the projectversion(integer): Version of the project; send it back on change (409 version_conflict when it is outdated)warnPercent(integer): Budget warning from this share (default 80) (max 100)
today(string (date)): The day the findings are computed for (Europe/Berlin)
Example 200 answer:
{
"dependencies": [
{
"createdAt": "2026-11-02T07:30:00Z",
"createdBy": "emma.maier@muster-it.example",
"id": "8e5f6a7b-9c0d-4e1f-8a3b-5c6d7e8f9a01",
"kind": "finish_to_start",
"lagDays": 1,
"predecessorId": "4a1b2c3d-5e6f-4a7b-8c9d-1e2f3a4b5d0b",
"projectId": "5b2c3d4e-6f7a-4b8c-9d0e-2f3a4b5c6d01",
"successorId": "4a1b2c3d-5e6f-4a7b-8c9d-1e2f3a4b5d0c"
}
],
"findings": [
{
"days": 5,
"itemId": "4a1b2c3d-5e6f-4a7b-8c9d-1e2f3a4b5d0b",
"kind": "late"
},
{
"days": 3,
"kind": "milestone_late",
"milestoneId": "6c3d4e5f-7a8b-4c9d-8e1f-3a4b5c6d7e03"
}
],
"items": [
{
"assignees": [
{
"role": "owner",
"userRef": "emma.maier@muster-it.example"
}
],
"endOn": "2026-11-15",
"estimateMinutes": null,
"id": "4a1b2c3d-5e6f-4a7b-8c9d-1e2f3a4b5d09",
"number": 56,
"parentId": null,
"phase": "active",
"projectMilestoneId": null,
"spaceId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7d00",
"spentMinutes": 600,
"startOn": "2026-11-10",
"status": "in_arbeit",
"title": "Datenübernahme",
"typeId": "5d2e3f4a-6b7c-4d8e-9f0a-2b3c4d5e6f06",
"version": 3
},
{
"assignees": [
{
"role": "owner",
"userRef": "paul.schmid@muster-it.example"
}
],
"endOn": "2026-11-13",
"estimateMinutes": 480,
"id": "4a1b2c3d-5e6f-4a7b-8c9d-1e2f3a4b5d0b",
"number": 58,
"parentId": "4a1b2c3d-5e6f-4a7b-8c9d-1e2f3a4b5d09",
"phase": "active",
"projectMilestoneId": "6c3d4e5f-7a8b-4c9d-8e1f-3a4b5c6d7e03",
"spaceId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7d00",
"spentMinutes": 540,
"startOn": "2026-11-12",
"status": "in_arbeit",
"title": "Probeimport und Prüfung",
"typeId": "5d2e3f4a-6b7c-4d8e-9f0a-2b3c4d5e6f07",
"version": 4
}
],
"milestones": [
{
"achievedAt": null,
"completion": "items",
"dueOn": "2026-11-15",
"id": "6c3d4e5f-7a8b-4c9d-8e1f-3a4b5c6d7e03",
"items": 3,
"itemsDone": 1,
"position": 2,
"projectId": "5b2c3d4e-6f7a-4b8c-9d0e-2f3a4b5c6d01",
"scope": "project",
"title": "Daten übernommen",
"version": 1
}
],
"project": {
"customer": {
"id": "3c5e7a9c-1d3f-4b5a-9c7e-1a3c5e7a9c21",
"name": "Donau Maschinenbau AG"
},
"endOn": "2026-11-23",
"id": "5b2c3d4e-6f7a-4b8c-9d0e-2f3a4b5c6d01",
"number": 1,
"phase": "active",
"responsibleRef": "emma.maier@muster-it.example",
"spaceId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7d00",
"startOn": "2026-11-02",
"status": "laufend",
"title": "ERP-Einführung Donau Maschinenbau",
"version": 6
},
"today": "2026-11-18"
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/desk/v1/projects/string/plan' \
-H "Authorization: Bearer $ACCESS_TOKEN"