ConnectCloud Developers

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

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

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

Fields of the 200 answer:

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

Example 200 answer:

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

Example request

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

View as Markdown · Interactive reference · OpenAPI