Skip to content
GitmoapAPIBeta
Planissues
GET/groups/{group_id}/iterations/{iteration_id}

Get an iteration and how it is going

get_iteration
  • issue:read
    A token needs the issue:read scope: Read work items and their settingsGranted by mcp_agent, mcp_agent_write, read_api, read_repository, write_api, write_repository.Every operation this scope unlocks
  • Filtered across resources

    x-gitmoap-isolation: {"kind":"cross_resource_filtered"}

Returns one of the group's iterations with its progress, read from the work items in it as they are now: how many are open, completed and cancelled, the points it took on and completed, and what is still open to carry over. Only work items you can see are counted — an iteration may hold work from several repositories. To list the work items themselves, filter a work-item listing by iteration. Anyone who can see the group's work items may read it.

Parameters

Path
  • group_idGroupId (string · uuid)Group ID
  • iteration_idIterationId (string · uuid)Iteration ID

Responses

200The iteration and its rollupapplication/json
  • iterationIterationThe iteration.
    • The Iteration schema
    • created_atstringWhen it was created, ISO 8601.
    • due_dateCalendarDate (string)Its last day, included.
    • group_idGroupId (string · uuid)The group it belongs to.
    • iteration_idIterationId (string · uuid)The iteration's identifier.
    • start_dateCalendarDate (string)Its first day.
    • stateIterationStateupcomingcurrentclosedWhether it is upcoming, current or closed today, read from its dates — never stored.
    • titleIterationTitle (string)Its title.
    • updated_atstringWhen it last changed, ISO 8601.
    • cadence_idCadenceId (string · uuid) or nulloptionalThe cadence that generated it. Absent for an iteration created by hand, and for one whose cadence was deleted.
    • descriptionstring or nulloptionalWhat it is for, in Markdown. Absent when it has none.
    • sequenceinteger · int32 or nulloptional0–∞Its position in the cadence that generated it, counted from 1. Absent for an iteration created by hand.
  • rollupIterationRollupHow it is going.
    • The IterationRollup schema
    • cancelledinteger · int320–∞Those closed without being completed.
    • carry_overinteger · int320–∞Work items still open: what would carry over into the next iteration if this one ended now, and what did carry once it has ended.
    • carry_over_pointsinteger · int320–∞The points of the work items still open.
    • committed_pointsinteger · int320–∞The points of every work item in it that is not cancelled — what the iteration took on.
    • completedinteger · int320–∞Those completed.
    • completed_pointsinteger · int320–∞The points of its completed work items.
    • openinteger · int320–∞Those still open.
    • totalinteger · int320–∞Work items in the iteration.
200 exampleSynthesized example
{
"iteration": {
"created_at": "2026-10-13T09:44:25Z",
"due_date": "due-date-5e1b",
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"iteration_id": "258dddf3-3e8e-418d-b90b-7cef355bf812",
"start_date": "start-date-4d3b",
"state": "upcoming",
"title": "Draw the region map from operation density",
"updated_at": "2026-10-15T09:40:44Z",
"cadence_id": "808cc7ab-2fb8-46e2-b378-3e51c211372b",
"description": "Renders each region as density contours of its operations.",
"sequence": 65
},
"rollup": {
"cancelled": 46,
"carry_over": 3,
"carry_over_points": 12,
"committed_points": 40,
"completed": 24,
"completed_points": 68,
"open": 82,
"total": 2
}
}
400Bad request — a path parameter is not a well-formed value of its typeapplication/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-0537",
"message": "Label every synthesized example"
}
}
401Unauthenticated — no credential, or an invalid oneapplication/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-005a",
"message": "Stream pipeline status into the run header"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-3ce3",
"message": "Label every synthesized example"
}
}
404Iteration not found in this groupapplication/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-58dd",
"message": "Draw the region map from operation density"
}
}

CLI

gitmoap issues get-iteration

  • --group-ididGroup ID (id or group path)
  • --iteration-ididIteration ID

Used in these guides