ConnectCloud Developers

List the item types of a project (tenant:forge:read)

GET /api/forge/v1/projects/{key}/item-types

Module: Forge · operationId: listForgeItemTypes · 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 The item types (application/json)
  • 404 Error (application/json)

Fields of the 200 answer:

  • items (array of ItemType, required)
    • 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

Example 200 answer:

{
  "items": [
    {
      "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"
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/forge/v1/projects/string/item-types' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI