ConnectCloud Developers

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 order
    • id (string (uuid), required): Field id
    • key (string, required): Field key: the key in customFields of an item; never changes
    • kind (string, required): Value type; never changes (one of text, longtext, number, date, datetime, bool, select, multiselect, user, url)
    • label (string, required): Display label
    • options (array of FieldOption, required): Choices of select and multiselect fields
    • position (integer, required): Order in the configuration
    • required (boolean, required): Items of the types the field applies to need a value
    • typeKeys (array of string, required): Item type keys; empty = every type
    • version (integer, required): Optimistic-locking version; send it with PATCH
  • itemTemplates (array of ItemTemplate, required): Item templates in position order
    • body (string, required): Markdown
    • id (string (uuid), required): Template id
    • key (string, required): Template key (templateKey of a new item)
    • labelIds (array of string (uuid), required): Labels it sets
    • name (string, required): Display name
    • position (integer, required): Order in the configuration
    • title (string, required): Title it prefills
    • version (integer, required): Optimistic-locking version; send it with PATCH
    • typeId (string (uuid), nullable): Item type it sets; null = none
  • itemTypes (array of ItemType, required): Item types in position order
    • archived (boolean, required): Archived: no new items of the type
    • icon (string, required): Icon name shown in the portal
    • id (string (uuid), required): Item type id
    • key (string, required): Type key; never changes
    • level (integer, required): 0 = leaf; a parent type has a higher level (max 5)
    • name (string, required): Display name
    • position (integer, required): Order in the configuration
    • version (integer, required): Optimistic-locking version; send it with PATCH
    • workflowId (string (uuid), required): Workflow the items of the type follow
  • labels (array of Label, required): Labels sorted by name
    • color (string, required): Color token (neutral, primary, …) or #rrggbb
    • description (string, required): Description
    • id (string (uuid), required): Label id
    • name (string, required): scope::value makes it exclusive within the scope
    • version (integer, required): Optimistic-locking version; send it with PATCH
  • ownerships (array of Ownership, required): Ownerships (code ownership) in position order
    • deputyRefs (array of string, required): E-mails of the deputies (members, at least developer); need an owner of their own
    • description (string, required): Description (max length 2000)
    • id (string (uuid), required): Ownership id
    • itemTypes (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 is owner::<key>)
    • labelId (string (uuid), required): The ownership's label owner::<key>; items carry it and it wins over the matchers
    • matchLabelIds (array of string (uuid), required): Plain labels (never owner::…): items carrying one belong here (without an owner:: label); the later position wins
    • name (string, required): Display name (max length 80)
    • ownerRef (string, nullable, required): E-mail of the owner person (a member, at least developer); exclusive with ownerTeamId
    • ownerTeamId (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 applies
    • paths (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 match
    • version (integer, required): Optimistic-locking version; send it with PATCH
  • sectionDefs (array of SectionDef, required): Section definitions in position order
    • id (string (uuid), required): Section definition id
    • key (string, required): Section key; never changes
    • kind (string, required): markdown or checklist (one of markdown, checklist)
    • label (string, required): Display label
    • placement (string, required): Where the portal shows it: a tab or the side column (one of tab, aside)
    • position (integer, required): Order in the configuration
    • typeKeys (array of string, required): Item type keys the section applies to; empty = every type
    • version (integer, required): Optimistic-locking version; send it with PATCH
  • statuses (array of Status, required): Statuses in position order
    • category (string, required): Status category (the group the status belongs to) (one of triage, todo, active, on_hold, done, cancelled)
    • color (string, required): Color token (neutral, primary, …) or #rrggbb
    • id (string (uuid), required): Status id
    • isDefault (boolean, required): Where new items start; exactly one, in triage or todo
    • key (string, required): Status key; never changes
    • name (string, required): Display name
    • position (integer, required): Order in the configuration
    • version (integer, required): Optimistic-locking version; send it with PATCH
  • teams (array of Team, required): Teams in position order
    • description (string, required): Description (max length 2000)
    • id (string (uuid), required): Team id
    • key (string, required): Team key; never changes
    • memberRefs (array of string, required): E-mails, the first is the lead
    • name (string, required): Display name (max length 80)
    • position (integer, required): Order in the configuration
    • version (integer, required): Optimistic-locking version; send it with PATCH
  • workflows (array of Workflow, required): Workflows in position order
    • id (string (uuid), required): Workflow id
    • key (string, required): Workflow key; never changes
    • name (string, required): Display name
    • position (integer, required): Order in the configuration
    • statusIds (array of string (uuid), required): Statuses of the workflow
    • transitions (array of Transition, required): Empty = free movement among the statuses
    • version (integer, required): Optimistic-locking version; send it with PATCH
  • members (array of Member, required): Members of the project
    • addedAt (string (date-time), required): When the member was added
    • addedBy (string, required): E-mail of who added the member
    • ref (string, required): Lower-cased e-mail address
    • role (Role, required): (one of reporter, developer, maintainer, admin)
  • project (ProjectView, required)
    • acceptsIntake (boolean, required): Callers with only tenant:forge:intake may hand desk tickets to the project
    • access (Capabilities, required)
      • canConfigure (boolean, required): Change the project configuration (statuses, types, labels, fields, templates, repositories)
      • canCreateItem (boolean, required): Create items and comment
      • canDeleteItem (boolean, required): Delete items and anyone's comments
      • canEditItem (boolean, required): Edit items (status, fields, labels, assignees, sections, links)
      • canManage (boolean, required): Members, project settings, archive, delete
      • canPlan (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 project
      • member (boolean, required): The caller is a member of the project
      • role (string, required): Effective role; empty when none
    • createdAt (string (date-time), required): When the project was created
    • createdBy (string, required): E-mail of who created the project
    • description (string, required): Markdown
    • id (string (uuid), required): Project id
    • key (string, required): Project key, prefix of item references (APP-12); never changes
    • name (string, required): Project name
    • settings (object, required): Project settings (handoff, code intake, planning agent), each changed through its own PUT route
    • state (string, required): active or archived (archived: read-only) (one of active, archived)
    • updatedAt (string (date-time), required): Last change
    • version (integer, required): Optimistic-locking version; send it with PATCH
    • visibility (string, required): private: members and tenant forge admins; tenant: every forge reader (one of private, tenant)
    • defaultTypeId (string (uuid), nullable): Default item type of new items; null when none
    • spentMinutes (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 repositories
    • createdAt (string (date-time), required): When it was linked
    • fullName (string, required): owner/name
    • id (string (uuid), required): Repository link id
    • isDefault (boolean, required): The default repository of the project
    • provider (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"

View as Markdown · Interactive reference · OpenAPI