Skip to content
GitmoapAPIBeta
Planissues
GET/groups/{group_id}/iteration-cadences/{cadence_id}

Get an iteration cadence

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

Returns one of the group's cadences: its schedule, how far ahead it creates iterations, whether it is active, and the number of the last iteration it generated. Anyone who can see the group's work items may read it.

Parameters

Path
  • group_idGroupId (string · uuid)Group ID
  • cadence_idCadenceId (string · uuid)Cadence ID

Responses

200The cadenceapplication/json
  • activebooleanWhether it generates iterations. A paused cadence generates nothing and keeps what it made.
  • cadence_idCadenceId (string · uuid)The cadence's identifier.
  • cool_down_weeksinteger · int320–∞Weeks left between one iteration's end and the next one's start, which belong to no iteration: 0 to 4. Shape Up's cool-down between cycles.
  • created_atstringWhen it was created, ISO 8601.
  • duration_weeksinteger · int320–∞How long each iteration runs, in weeks: 1 to 12.
  • first_start_dateCalendarDate (string)The date the schedule starts from. The first iteration begins on the first start_day on or after it.
  • generated_throughinteger · int320–∞The number of the last iteration it has generated, or 0 before the first.
  • group_idGroupId (string · uuid)The group whose iterations it generates.
  • iterations_in_advanceinteger · int320–∞How many upcoming iterations are kept created ahead of today: 1 to 12.
  • start_dayWeekdaymondaytuesdaywednesdaythursdayfridaysaturdaysundayThe weekday every iteration begins on.
  • titleCadenceTitle (string)Its title. Each iteration it generates is titled with it and the iteration's number.
  • updated_atstringWhen it last changed, ISO 8601.
200 exampleSynthesized example
{
"active": true,
"cadence_id": "a1a314f6-892e-4f9d-9bfe-d4465b6e9ee4",
"cool_down_weeks": 34,
"created_at": "2026-10-17T04:32:47Z",
"duration_weeks": 9,
"first_start_date": "first-start-date-471d",
"generated_through": 78,
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"iterations_in_advance": 21,
"start_day": "monday",
"title": "Pin a page's payload to the build that rendered it",
"updated_at": "2026-10-14T23:22:51Z"
}
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-0eab",
"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-6f74",
"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-73e1",
"message": "Label every synthesized example"
}
}
404Cadence 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-e3f5",
"message": "Inline scalar newtypes but keep their brand"
}
}

CLI

gitmoap issues get-iteration-cadence

  • --group-ididGroup ID (id or group path)
  • --cadence-ididCadence ID

Used in these guides