Skip to content
GitmoapAPIBeta
Schema

Iteration

A dated container of work in a group, such as a sprint. Work items from the group and from any repository beneath it can be put in it.

Shape

  • 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.

Example

Synthesized example
{
"created_at": "2026-10-13T05:19:24Z",
"due_date": "due-date-f9da",
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"iteration_id": "76ea1803-ff8e-4a52-ba91-f7486f57b71d",
"start_date": "start-date-861d",
"state": "upcoming",
"title": "Stream pipeline status into the run header",
"updated_at": "2026-10-16T18:03:25Z",
"cadence_id": "6bf1f981-b04d-43b1-ab44-b10d7b0c95b0",
"description": "Renders each region as density contours of its operations.",
"sequence": 82
}

Graph

Contains

No named schema inside.

Used by