ConnectCloud Developers

Start an iteration (tenant:forge:write and, as a member, at least developer)

POST /api/forge/v1/projects/{key}/iterations/{id}/start

Module: Forge · operationId: startForgeIteration · Tag: Iterations · Auth: access token (Authorization: Bearer <accessToken>)

Same permission as creating. Only a planned iteration starts (409 iteration_not_planned) and only while no other iteration of the project is active (409 iteration_active). The summed estimates of its non-cancelled items are stored as progress.committed. Writes forge.iteration.started.

Parameters

Name In Type Required Description
key path string yes Project key (e.g. APP)
id path string (uuid) yes

Responses

  • 200 Started (application/json)
  • 403 Error (application/json)
  • 404 Error (application/json)
  • 409 Error (application/json)

Fields of the 200 answer:

  • closedAt (string (date-time), nullable, required): When it was closed; null until then
  • createdAt (string (date-time), required): When it was created
  • endsOn (string (date), required): Last day
  • goal (string, required): Goal of the iteration
  • id (string (uuid), required): Iteration id
  • name (string, required): Name
  • position (integer, required): Order of the iterations
  • startedAt (string (date-time), nullable, required): When it was started; null while planned
  • startsOn (string (date), required): First day
  • state (string, required): planned, active (at most one per project) or closed (one of planned, active, closed)
  • updatedAt (string (date-time), required): Last change
  • version (integer, required): Optimistic-locking version; send it with PATCH
  • progress (IterationProgress, required): Planned and active iterations count the items in them now; a closed iteration counts its snapshot (every item as it stood at the close, carried-over ones included).

Example 200 answer:

{
  "closedAt": null,
  "createdAt": "2026-10-28T11:00:00Z",
  "endsOn": "2026-11-24",
  "goal": "Kunden sehen ihre Tickets mit Filtern und laden lange Listen nach.",
  "id": "f1b2c3d4-e5f6-4a7b-9c34-1f2a3b4c5d02",
  "name": "Iteration 2 – Ticketübersicht",
  "position": 1,
  "progress": {
    "byCategory": {
      "active": 2,
      "cancelled": 0,
      "done": 4,
      "on_hold": 0,
      "todo": 1,
      "triage": 0
    },
    "committed": 16,
    "estimate": {
      "done": 9,
      "total": 19
    },
    "total": 7
  },
  "startedAt": "2026-11-04T09:30:00Z",
  "startsOn": "2026-11-04",
  "state": "active",
  "updatedAt": "2026-11-04T09:30:00Z",
  "version": 3
}

Example request

curl -X POST 'https://api.mbcom.cloud/api/forge/v1/projects/string/iterations/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12/start' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI