Skip to content
GitmoapAPIBeta
Planissues
DELETE/groups/{group_id}/issues/{issue_id}/iteration

Take a group work item out of its iteration

remove_group_issue_iteration
  • issue:update
    A token needs the issue:update scope: Update work items — status, fields, hierarchyGranted by mcp_agent_write, write_api, write_repository.Every operation this scope unlocks
  • Audited · mutation

    x-gitmoap-audit: {"kind":"audited","arg":"mutation"}

Clears the work item's iteration, records it on its activity, and returns the item; a work item in no iteration comes back unchanged. Developers and above may do this on any work item, and its author on their own.

Parameters

Path
  • group_idGroupId (string · uuid)Group ID
  • issue_idIssueId (integer · int64)Work-item iid

Responses

200The work itemapplication/json
  • created_atstring
  • created_byActorSummaryWho created the work item, as they were when they created it.
    • The ActorSummary schema
    • emailstringThe principal's address. An agent's is a generated no-reply address — the author of its commits. unknown on a deleted actor and empty on a redacted one.
    • idstringThe principal's id: a user id, a service account id or an agent id, as kind says. Empty on a redacted actor.
    • usernamestringThe name to show: a person's or service account's username, or an agent's handle (which always ends in -ai). deleted-user when the actor no longer resolves, redacted when the caller may not see who it was.
    • avatar_urlstring or nulloptionalThe principal's picture, when one is known. Absent otherwise: a client derives the deterministic avatar URL itself.
    • kindPrincipalKinduserservice_accountagentor nulloptionalWhat the actor is — a person, a service account or an AI organization's agent — and so which page it links to. Absent on a placeholder (a redacted or deleted actor) and on an actor that is not a principal, such as the platform's own system actor; a client draws such an actor unlinked.
  • iidIssueId (integer · int64)
  • root_scope_idGroupId (string · uuid)The top-level group the item's group or repository belongs to.
  • scope_idstring
  • scope_typeScopeTypegrouprepositoryWhether the item lives in a group or a repository. With scope_id and iid it forms the item's current address — the #412 a person types — which changes when the item moves.
  • status_categoryStatusCategorytriagetodoin_progressin_reviewblockeddonecancelledThe fixed category of the item's current status, which boards, filters and progress rollups work from.
  • status_idStatusId (string)
  • titleIssueTitle (string)
  • uidIssueUid (string · uuid)The work item's permanent identifier. Unlike its number, it never changes, even when the item moves to another group or repository.
  • updated_atstringWhen the work item last changed, ISO 8601. Listings order by it, newest first.
  • work_item_typeWorkItemTypeepicstorybugtaskspikechoreincidentsub_taskThe kind of work item. The type decides where an item may live (a group or a repository), which types it may have as children, and which fields it accepts.
  • ancestor_group_idsarray of GroupId (string · uuid)optionalThe groups the item sits beneath, nearest first.
  • ancestor_issue_uidsarray of IssueUid (string · uuid)optionalThe item's ancestors' permanent identifiers, nearest first, for display. It can briefly lag behind a change of parent higher up the chain.
  • assignee_idsarray of PrincipalId (string · uuid)optionalThe people assigned to the work item. Absent when nobody is.
  • author_can_pushboolean or nulloptionalWhether the author can push to where this work item lives — its repository, or a group work item's group. False for a drive-by contributor's text. Absent where it was not computed.
  • closed_atstring or nulloptional
  • closed_byPrincipalId (string · uuid) or nulloptional
  • descriptionMarkdownDoc (string) or nulloptional
  • iteration_idIterationId (string · uuid) or nulloptionalThe iteration the work item is in — one of its own group's, or of a group above it. Absent when it is in none.
  • labelsarray of LabelKey (string)optionalThe keys of the labels applied to the work item. Absent when it has none.
  • milestone_idMilestoneId (string · uuid) or nulloptional
  • milestone_scope_idstring or nulloptional
  • milestone_scope_typeScopeTypegrouprepositoryor nulloptionalWhether the item's milestone belongs to a group or a repository — not necessarily the item's own, since a group milestone can hold work items from several repositories.
  • parent_refIssueRef or nulloptionalThe parent's current address, for display. Absent when the item has no parent.
  • parent_uidIssueUid (string · uuid) or nulloptionalThe parent work item's permanent identifier, if the item has a parent.
  • pointsinteger · int32 or nulloptional0–∞
  • regressed_atstring or nulloptional
  • regressed_at_shaCommitHash (string) or nulloptionalThe commit whose evidence proved the regression — the first known bad commit, and the upper end of the range of suspect commits.
  • regressed_from_shaCommitHash (string) or nulloptionalThe commit at which the item was last verified, kept when it regresses — the last known good commit.
  • regressed_run_idPipelineRunId (string · uuid) or nulloptional
  • severitySeveritycriticalhighmediumlowor nulloptional
  • type_profileBlueprintRef or nulloptionalThe custom type this item was filed as, pointing at the group or repository where the blueprint is defined. work_item_type still decides where the item may live, its children and its fields; the blueprint adds a display label and facets. Absent for an item filed as a plain built-in type.
  • verificationVerificationStateunverifiedverifiedregressedoptionalWhether CI has proved the work item's acceptance criteria. unverified until a pipeline run proves them, verified once one has, and regressed when a later run shows that evidence no longer holds.
  • verified_atstring or nulloptional
  • verified_at_shaCommitHash (string) or nulloptionalThe commit at which CI proved the acceptance criteria. Absent until a pipeline run has.
  • verified_run_idPipelineRunId (string · uuid) or nulloptional
  • versioninteger · int64optional0–∞The work item's revision, incremented on every change. Send it back with an update; if the item has changed since you read it, the update is refused with a 409.
200 exampleSynthesized example
{
"created_at": "2026-10-10T20:51:38Z",
"created_by": {
"email": "mara@acme.example",
"id": "id-97c4",
"username": "tomas",
"avatar_url": "https://gitmoap.example/acme/ae4b9c1a",
"kind": "user"
},
"iid": 38,
"root_scope_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"scope_id": "b9e61cba-7c62-48c2-a68c-6c200cff2ef5",
"scope_type": "group",
"status_category": "triage",
"status_id": "2841392e-57e8-4ea0-a3a8-c87129e8cd67",
"title": "Label every synthesized example",
"uid": "68b77aa0-282d-4d77-a480-16f8bea5a40c",
"updated_at": "2026-10-11T07:30:04Z",
"work_item_type": "epic",
"ancestor_group_ids": [
"4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
],
"ancestor_issue_uids": [
"a41f911a-df1c-4089-9a67-2755f803e754",
"735f20ab-15d0-40f3-8e3c-3a873dfa6624"
],
"assignee_ids": [
"c407bd3e-2dbe-438a-a04f-8a7827985eef",
"393a165c-89a4-49ed-97b6-cc68170f434b"
],
"author_can_push": false,
"closed_at": "2026-10-14T02:34:13Z",
"closed_by": "c9d8e7f6-a5b4-4c3d-9e2f-1a0b9c8d7e6f",
"description": "Renders each region as density contours of its operations.",
"iteration_id": "2f25714a-396d-4dc0-87a2-d2dc0fe495ca",
"labels": [
"labels-c963",
"labels-971f"
],
"milestone_id": "fd6b28d6-af28-4739-939a-e6726966286d",
"milestone_scope_id": "44c2b623-8211-4c7d-bfb1-1fd5b4a8009b",
"milestone_scope_type": "group",
"parent_ref": {
"iid": 7,
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
}
},
"parent_uid": "b4c58a84-bf41-4681-9f2a-4170effeca42",
"points": 41,
"regressed_at": "2026-10-10T22:01:56Z",
"regressed_at_sha": "3fc118173effe4edafe31efda15cb5a673b67f48",
"regressed_from_sha": "9c42fb298cda4a1fea46ac6db91fe42f790f36d5",
"regressed_run_id": "9e2b7c41-3d5a-4f8e-b1c2-7a6d5e4f3c2b",
"severity": "critical",
"type_profile": {
"blueprint_id": "0117312c-440f-48bc-a363-b376f2690d13",
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
}
},
"verification": "unverified",
"verified_at": "2026-10-09T07:40:35Z",
"verified_at_sha": "cb6cd62c32b28a53c6fc35812939b49cabdb9cf7",
"verified_run_id": "9e2b7c41-3d5a-4f8e-b1c2-7a6d5e4f3c2b",
"version": 40
}
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-b2ce",
"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-c5b9",
"message": "Inline scalar newtypes but keep their brand"
}
}
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-0c8d",
"message": "Stream pipeline status into the run header"
}
}
404Not found — or found and private, which is masked as absentapplication/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-9dbf",
"message": "Pin a page's payload to the build that rendered it"
}
}
409The request conflicts with the resource's current state; `reason` says howapplication/json
Error codes
  • CONFLICTThe request conflicts with the resource's current state; reason says how
  • LEGAL_ACCEPTANCE_REQUIREDAccept the current Terms of Service before changing anything; reading stays open
  • 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.
409 exampleSynthesized example
{
"error": {
"code": "code-c50e",
"message": "Pin a page's payload to the build that rendered it"
}
}

CLI

gitmoap issues remove-group-iteration

  • --group-ididGroup ID (id or group path)
  • --issue-ididWork-item iid

Used in these guides