Project page bootstrap (project, configuration, members, repositories) (tenant:forge:read)
GET /api/forge/v1/projects/{key}/config
Module: Forge · operationId: getForgeProjectConfig · Tag: Configuration · Auth: access token (Authorization: Bearer <accessToken>)
Requires tenant:forge:read and a project the caller sees.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
key |
path | string | yes | Project key (e.g. APP) |
Responses
- 200 Bootstrap (
application/json) - 404 Error (
application/json)
Fields of the 200 answer:
customFields(array of CustomField, required): Custom fields in position orderid(string (uuid), required): Field idkey(string, required): Field key: the key incustomFieldsof an item; never changeskind(string, required): Value type; never changes (one oftext,longtext,number,date,datetime,bool,select,multiselect,user,url)label(string, required): Display labeloptions(array of FieldOption, required): Choices of select and multiselect fieldsposition(integer, required): Order in the configurationrequired(boolean, required): Items of the types the field applies to need a valuetypeKeys(array of string, required): Item type keys; empty = every typeversion(integer, required): Optimistic-locking version; send it with PATCH
itemTemplates(array of ItemTemplate, required): Item templates in position orderbody(string, required): Markdownid(string (uuid), required): Template idkey(string, required): Template key (templateKeyof a new item)labelIds(array of string (uuid), required): Labels it setsname(string, required): Display nameposition(integer, required): Order in the configurationtitle(string, required): Title it prefillsversion(integer, required): Optimistic-locking version; send it with PATCHtypeId(string (uuid), nullable): Item type it sets; null = none
itemTypes(array of ItemType, required): Item types in position orderarchived(boolean, required): Archived: no new items of the typeicon(string, required): Icon name shown in the portalid(string (uuid), required): Item type idkey(string, required): Type key; never changeslevel(integer, required): 0 = leaf; a parent type has a higher level (max 5)name(string, required): Display nameposition(integer, required): Order in the configurationversion(integer, required): Optimistic-locking version; send it with PATCHworkflowId(string (uuid), required): Workflow the items of the type follow
labels(array of Label, required): Labels sorted by namecolor(string, required): Color token (neutral, primary, …) or #rrggbbdescription(string, required): Descriptionid(string (uuid), required): Label idname(string, required): scope::value makes it exclusive within the scopeversion(integer, required): Optimistic-locking version; send it with PATCH
ownerships(array of Ownership, required): Ownerships (code ownership) in position orderdeputyRefs(array of string, required): E-mails of the deputies (members, at least developer); need an owner of their owndescription(string, required): Description (max length 2000)id(string (uuid), required): Ownership iditemTypes(array of string, required): Item type keys: items of these types belong here (without an owner:: label)key(string, required): Key; never changes (its label isowner::<key>)labelId(string (uuid), required): The ownership's labelowner::<key>; items carry it and it wins over the matchersmatchLabelIds(array of string (uuid), required): Plain labels (neverowner::…): items carrying one belong here (without an owner:: label); the later position winsname(string, required): Display name (max length 80)ownerRef(string, nullable, required): E-mail of the owner person (a member, at least developer); exclusive with ownerTeamIdownerTeamId(string (uuid), nullable, required): The owning team; exclusive with ownerRef. Neither is allowed only with a parent (inherited)parentId(string (uuid), nullable, required): The parent ownership (same project, no cycle, at most 4 levels); without an owner of its own the nearest ancestor's appliespaths(array of string, required): Repository path patterns, the CODEOWNERS subset: segments separated by/,*and?within a segment,**as a whole segment for any number of directories. A pattern without/(other than a trailing one) matches at any depth, one with/is relative to the root (a leading/anchors explicitly); a trailing/matches directories. A pattern whose last segment has no wildcard also matches everything below the directory it names (hr,/apps/github); one ending in a wildcard matches only what it names (docs/*). No character classes,\,!,#or spaces. Paths decide only for code (CODEOWNERS, scm).position(integer, required): Precedence: a later ownership wins a path or an item both matchversion(integer, required): Optimistic-locking version; send it with PATCH
sectionDefs(array of SectionDef, required): Section definitions in position orderid(string (uuid), required): Section definition idkey(string, required): Section key; never changeskind(string, required): markdown or checklist (one ofmarkdown,checklist)label(string, required): Display labelplacement(string, required): Where the portal shows it: a tab or the side column (one oftab,aside)position(integer, required): Order in the configurationtypeKeys(array of string, required): Item type keys the section applies to; empty = every typeversion(integer, required): Optimistic-locking version; send it with PATCH
statuses(array of Status, required): Statuses in position ordercategory(string, required): Status category (the group the status belongs to) (one oftriage,todo,active,on_hold,done,cancelled)color(string, required): Color token (neutral, primary, …) or #rrggbbid(string (uuid), required): Status idisDefault(boolean, required): Where new items start; exactly one, in triage or todokey(string, required): Status key; never changesname(string, required): Display nameposition(integer, required): Order in the configurationversion(integer, required): Optimistic-locking version; send it with PATCH
teams(array of Team, required): Teams in position orderdescription(string, required): Description (max length 2000)id(string (uuid), required): Team idkey(string, required): Team key; never changesmemberRefs(array of string, required): E-mails, the first is the leadname(string, required): Display name (max length 80)position(integer, required): Order in the configurationversion(integer, required): Optimistic-locking version; send it with PATCH
workflows(array of Workflow, required): Workflows in position orderid(string (uuid), required): Workflow idkey(string, required): Workflow key; never changesname(string, required): Display nameposition(integer, required): Order in the configurationstatusIds(array of string (uuid), required): Statuses of the workflowtransitions(array of Transition, required): Empty = free movement among the statusesversion(integer, required): Optimistic-locking version; send it with PATCH
members(array of Member, required): Members of the projectaddedAt(string (date-time), required): When the member was addedaddedBy(string, required): E-mail of who added the memberref(string, required): Lower-cased e-mail addressrole(Role, required): (one ofreporter,developer,maintainer,admin)
project(ProjectView, required)acceptsIntake(boolean, required): Callers with onlytenant:forge:intakemay hand desk tickets to the projectaccess(Capabilities, required)canConfigure(boolean, required): Change the project configuration (statuses, types, labels, fields, templates, repositories)canCreateItem(boolean, required): Create items and commentcanDeleteItem(boolean, required): Delete items and anyone's commentscanEditItem(boolean, required): Edit items (status, fields, labels, assignees, sections, links)canManage(boolean, required): Members, project settings, archive, deletecanPlan(boolean, required): Create, edit, close and reopen milestones; create, edit, start, close and delete iterations and put items into them (the rule of canEditItem)canUseAgent(boolean, required): The planning agent may work on this item for the caller (canEditItem, the project enabled the agent, active project, not converted); always false on a projectmember(boolean, required): The caller is a member of the projectrole(string, required): Effective role; empty when none
createdAt(string (date-time), required): When the project was createdcreatedBy(string, required): E-mail of who created the projectdescription(string, required): Markdownid(string (uuid), required): Project idkey(string, required): Project key, prefix of item references (APP-12); never changesname(string, required): Project namesettings(object, required): Project settings (handoff, code intake, planning agent), each changed through its own PUT routestate(string, required): active or archived (archived: read-only) (one ofactive,archived)updatedAt(string (date-time), required): Last changeversion(integer, required): Optimistic-locking version; send it with PATCHvisibility(string, required):private: members and tenant forge admins;tenant: every forge reader (one ofprivate,tenant)defaultTypeId(string (uuid), nullable): Default item type of new items; null when nonespentMinutes(integer, nullable, read-only): Work HR booked with the project as reference (forge:project:<id>, worked minus breaks, ADR 0040); filled by the project read and list, null when HR does not answer (never an error)workCustomer(WorkCustomer | null): How work on the project and its items is booked in HR (ADR 0040); null = no setting (the person picks the customer)
repositories(array of Repository, required): Linked repositoriescreatedAt(string (date-time), required): When it was linkedfullName(string, required): owner/nameid(string (uuid), required): Repository link idisDefault(boolean, required): The default repository of the projectprovider(string, required): Repository provider key: github, gitlab or gitlab@ (self-managed GitLab)baseBranch(string, nullable): Base branch for new branches; null = the repository's default branch
Example 200 answer:
{
"customFields": [
{
"id": "9b5c6d7e-8f9a-4b0c-9dbe-5f6a7b8c9d01",
"key": "story_points",
"kind": "number",
"label": "Story Points",
"options": [],
"position": 0,
"required": false,
"typeKeys": [
"story",
"aufgabe",
"fehler"
],
"version": 1
}
],
"itemTemplates": [
{
"body": "## Beobachtet\n\n## Erwartet\n\n## Schritte zum Nachstellen\n\n1. \n",
"id": "ac6d7e8f-9a0b-4c1d-8ecf-6a7b8c9d0e01",
"key": "fehlerbericht",
"labelIds": [
"8a4b5c6d-7e8f-4a9b-8cad-4e5f6a7b8c04"
],
"name": "Fehlerbericht",
"position": 0,
"title": "",
"typeId": "7f3a4b5c-6d7e-4f8a-9b9c-3d4e5f6a7b04",
"version": 1
}
],
"itemTypes": [
{
"archived": false,
"icon": "i-lucide-mountain",
"id": "7f3a4b5c-6d7e-4f8a-9b9c-3d4e5f6a7b01",
"key": "epic",
"level": 3,
"name": "Epic",
"position": 0,
"version": 1,
"workflowId": "6e2f3a4b-5c6d-4e7f-9a8b-2c3d4e5f6a01"
},
{
"archived": false,
"icon": "i-lucide-book-open",
"id": "7f3a4b5c-6d7e-4f8a-9b9c-3d4e5f6a7b02",
"key": "story",
"level": 2,
"name": "Story",
"position": 1,
"version": 1,
"workflowId": "6e2f3a4b-5c6d-4e7f-9a8b-2c3d4e5f6a01"
},
{
"archived": false,
"icon": "i-lucide-square-check",
"id": "7f3a4b5c-6d7e-4f8a-9b9c-3d4e5f6a7b03",
"key": "aufgabe",
"level": 1,
"name": "Aufgabe",
"position": 2,
"version": 1,
"workflowId": "6e2f3a4b-5c6d-4e7f-9a8b-2c3d4e5f6a01"
},
{
"archived": false,
"icon": "i-lucide-bug",
"id": "7f3a4b5c-6d7e-4f8a-9b9c-3d4e5f6a7b04",
"key": "fehler",
"level": 1,
"name": "Fehler",
"position": 3,
"version": 1,
"workflowId": "6e2f3a4b-5c6d-4e7f-9a8b-2c3d4e5f6a01"
},
{
"archived": false,
"icon": "i-lucide-list-checks",
"id": "7f3a4b5c-6d7e-4f8a-9b9c-3d4e5f6a7b05",
"key": "subtask",
"level": 0,
"name": "Sub-Task",
"position": 4,
"version": 1,
"workflowId": "6e2f3a4b-5c6d-4e7f-9a8b-2c3d4e5f6a01"
}
],
"labels": [
{
"color": "info",
"description": "Oberfläche der App",
"id": "8a4b5c6d-7e8f-4a9b-8cad-4e5f6a7b8c01",
"name": "bereich::frontend",
"version": 1
},
{
"color": "error",
"description": "",
"id": "8a4b5c6d-7e8f-4a9b-8cad-4e5f6a7b8c04",
"name": "bug",
"version": 1
},
{
"color": "neutral",
"description": "Android-App",
"id": "8a4b5c6d-7e8f-4a9b-8cad-4e5f6a7b8c06",
"name": "owner::android",
"version": 1
},
{
"color": "success",
"description": "",
"id": "8a4b5c6d-7e8f-4a9b-8cad-4e5f6a7b8c05",
"name": "plattform::android",
"version": 1
},
{
"color": "error",
"description": "Hohe Priorität",
"id": "8a4b5c6d-7e8f-4a9b-8cad-4e5f6a7b8c03",
"name": "priority::hoch",
"version": 1
},
{
"color": "warning",
"description": "Mittlere Priorität",
"id": "8a4b5c6d-7e8f-4a9b-8cad-4e5f6a7b8c02",
"name": "priority::mittel",
"version": 1
},
{
"color": "primary",
"description": "Trägt zum Sprint-Ziel bei",
"id": "8a4b5c6d-7e8f-4a9b-8cad-4e5f6a7b8c07",
"name": "sprint-ziel",
"version": 1
}
],
"members": [
{
"addedAt": "2026-09-23T09:00:00Z",
"addedBy": "emma.maier@muster-it.example",
"ref": "emma.maier@muster-it.example",
"role": "maintainer"
},
{
"addedAt": "2026-09-23T09:05:00Z",
"addedBy": "emma.maier@muster-it.example",
"ref": "paul.schmid@muster-it.example",
"role": "developer"
},
{
"addedAt": "2026-09-23T09:05:00Z",
"addedBy": "emma.maier@muster-it.example",
"ref": "marie.wagner@muster-it.example",
"role": "developer"
},
{
"addedAt": "2026-09-23T09:06:00Z",
"addedBy": "emma.maier@muster-it.example",
"ref": "ben.koch@muster-it.example",
"role": "reporter"
}
],
"ownerships": [
{
"deputyRefs": [],
"description": "Gesamter Code der mobilen Apps.",
"id": "df9a0b1c-2d3e-4f4a-9b12-9d0e1f2a3b01",
"itemTypes": [],
"key": "apps",
"labelId": "8a4b5c6d-7e8f-4a9b-8cad-4e5f6a7b8c0a",
"matchLabelIds": [],
"name": "Apps",
"ownerRef": null,
"ownerTeamId": "ce8f9a0b-1c2d-4e3f-8a01-8c9d0e1f2a01",
"parentId": null,
"paths": [
"app/**"
],
"position": 0,
"version": 1
},
{
"deputyRefs": [
"paul.schmid@muster-it.example"
],
"description": "Kotlin-Code der Android-App.",
"id": "df9a0b1c-2d3e-4f4a-9b12-9d0e1f2a3b02",
"itemTypes": [],
"key": "android",
"labelId": "8a4b5c6d-7e8f-4a9b-8cad-4e5f6a7b8c06",
"matchLabelIds": [],
"name": "Android-App",
"ownerRef": "marie.wagner@muster-it.example",
"ownerTeamId": null,
"parentId": "df9a0b1c-2d3e-4f4a-9b12-9d0e1f2a3b01",
"paths": [
"app/android/**"
],
"position": 1,
"version": 1
}
],
"project": {
"acceptsIntake": true,
"access": {
"canConfigure": true,
"canCreateItem": true,
"canDeleteItem": true,
"canEditItem": true,
"canManage": false,
"canPlan": true,
"canUseAgent": false,
"member": true,
"role": "maintainer"
},
"createdAt": "2026-09-23T09:00:00Z",
"createdBy": "emma.maier@muster-it.example",
"defaultTypeId": "7f3a4b5c-6d7e-4f8a-9b9c-3d4e5f6a7b03",
"description": "Die mobile App für Kunden von Muster IT: Tickets ansehen, Rückfragen beantworten und Geräte-Inventar einsehen.",
"id": "0b6c1e1e-3f0b-4e8e-9f3f-1d2c3b4a5f60",
"key": "APP",
"name": "Kundenportal-App",
"settings": {
"planningAgent": {
"enabled": true,
"language": "de"
}
},
"state": "active",
"updatedAt": "2026-11-11T14:20:00Z",
"version": 7,
"visibility": "tenant",
"workCustomer": null
},
"repositories": [
{
"baseBranch": null,
"createdAt": "2026-09-23T09:10:00Z",
"fullName": "mbcomdev/demo-app",
"id": "4b5c6d7e-8f9a-4b1c-8d2e-3f4a5b6c7d01",
"isDefault": true,
"provider": "github"
}
],
"sectionDefs": [
{
"id": "bd7e8f9a-0b1c-4d2e-9fd0-7b8c9d0e1f01",
"key": "plan",
"kind": "markdown",
"label": "Plan",
"placement": "tab",
"position": 0,
"typeKeys": [],
"version": 1
},
{
"id": "bd7e8f9a-0b1c-4d2e-9fd0-7b8c9d0e1f02",
"key": "agent_notes",
"kind": "markdown",
"label": "Notizen für Agenten",
"placement": "tab",
"position": 1,
"typeKeys": [],
"version": 1
},
{
"id": "bd7e8f9a-0b1c-4d2e-9fd0-7b8c9d0e1f03",
"key": "acceptance",
"kind": "checklist",
"label": "Akzeptanzkriterien",
"placement": "tab",
"position": 2,
"typeKeys": [],
"version": 1
}
],
"statuses": [
{
"category": "triage",
"color": "neutral",
"id": "5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f01",
"isDefault": false,
"key": "triage",
"name": "Triage",
"position": 0,
"version": 1
},
{
"category": "todo",
"color": "info",
"id": "5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f02",
"isDefault": true,
"key": "offen",
"name": "Offen",
"position": 1,
"version": 1
},
{
"category": "active",
"color": "primary",
"id": "5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f03",
"isDefault": false,
"key": "in_arbeit",
"name": "In Arbeit",
"position": 2,
"version": 1
},
{
"category": "active",
"color": "warning",
"id": "5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f04",
"isDefault": false,
"key": "review",
"name": "Review",
"position": 3,
"version": 1
},
{
"category": "done",
"color": "success",
"id": "5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f05",
"isDefault": false,
"key": "erledigt",
"name": "Erledigt",
"position": 4,
"version": 1
},
{
"category": "cancelled",
"color": "neutral",
"id": "5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f06",
"isDefault": false,
"key": "verworfen",
"name": "Verworfen",
"position": 5,
"version": 1
}
],
"teams": [
{
"description": "Entwickler der iOS- und Android-App; Paul leitet das Team.",
"id": "ce8f9a0b-1c2d-4e3f-8a01-8c9d0e1f2a01",
"key": "mobile",
"memberRefs": [
"paul.schmid@muster-it.example",
"marie.wagner@muster-it.example"
],
"name": "Mobile-Team",
"position": 0,
"version": 1
}
],
"workflows": [
{
"id": "6e2f3a4b-5c6d-4e7f-9a8b-2c3d4e5f6a01",
"key": "standard",
"name": "Standard",
"position": 0,
"statusIds": [
"5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f01",
"5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f02",
"5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f03",
"5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f04",
"5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f05",
"5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f06"
],
"transitions": [],
"version": 1
}
]
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/forge/v1/projects/string/config' \
-H "Authorization: Bearer $ACCESS_TOKEN"