ConnectCloud Developers

List the labels of a project (tenant:forge:read)

GET /api/forge/v1/projects/{key}/labels

Module: Forge · operationId: listForgeLabels · 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 labels (application/json)
  • 404 Error (application/json)

Fields of the 200 answer:

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

Example 200 answer:

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

Example request

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

View as Markdown · Interactive reference · OpenAPI