Skip to content
GitmoapAPIBeta
Planissues
GET/repositories/{repo_id}/milestones/{milestone_id}

Get a milestone and its burndown

get_milestone
  • 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 repository's milestones with the work items in it and their progress: how many are open, completed and cancelled, and the total and completed points. Only work items you can see are listed or counted. Anyone who can see the repository's work items may read it.

Parameters

Path
  • repo_idRepositoryId (string · uuid)Repository ID
  • milestone_idMilestoneId (string · uuid)Milestone ID

Responses

200OKapplication/json
  • cancelledinteger · int320–∞
  • completedinteger · int320–∞
  • created_atstring
  • itemsarray of MilestoneItem
    • The MilestoneItem schema
    • issue_refIssueRefThe work item's current address: the group or repository it lives in, and its number there.
    • issue_uidIssueUid (string · uuid)
    • linked_atstring
    • milestone_idMilestoneId (string · uuid)
    • status_categoryStatusCategorytriagetodoin_progressin_reviewblockeddonecancelledThe status category the work item is in.
    • 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.
    • pointsinteger · int32 or nulloptional0–∞
  • milestone_idMilestoneId (string · uuid)
  • openinteger · int320–∞
  • points_completedinteger · int320–∞
  • points_totalinteger · int320–∞
  • scope_idstring
  • scope_typeScopeTypegrouprepository
  • titleMilestoneTitle (string)
  • totalinteger · int320–∞
  • updated_atstring
  • closedbooleanoptional
  • descriptionstring or nulloptional
  • due_onCalendarDate (string) or nulloptional
200 exampleSynthesized example
{
"cancelled": 33,
"completed": 8,
"created_at": "2026-10-09T20:56:01Z",
"items": [
{
"issue_ref": {
"iid": 16,
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
}
},
"issue_uid": "83ea87e7-dca4-46fa-b95b-c5b1d84abaa6",
"linked_at": "2026-10-10T19:34:01Z",
"milestone_id": "37737220-46de-4ab9-ad97-04fcb90d7f65",
"status_category": "triage",
"work_item_type": "epic"
}
],
"milestone_id": "912934a4-86ac-4d21-88f1-a5b0803e997f",
"open": 7,
"points_completed": 72,
"points_total": 0,
"scope_id": "e182ee47-3a9a-472e-b88f-875c1378f620",
"scope_type": "group",
"title": "Inline scalar newtypes but keep their brand",
"total": 5,
"updated_at": "2026-10-17T05:09:53Z",
"closed": false,
"description": "Renders each region as density contours of its operations.",
"due_on": "due-on-0f63"
}
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-1897",
"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-a5e6",
"message": "Pin a page's payload to the build that rendered it"
}
}
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-2969",
"message": "Inline scalar newtypes but keep their brand"
}
}
404Milestone not foundapplication/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-f848",
"message": "Pin a page's payload to the build that rendered it"
}
}

CLI

gitmoap issues get-milestone

  • --repo-ididRepository ID (id or owner/repo path)
  • --milestone-ididMilestone ID

Used in these guides