Skip to content
GitmoapAPIBeta
Planissues
GET/repositories/{repo_id}/issues/{issue_id}

Get one work item

get_issue
  • 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 the work item with the given number in the repository, including a reference to its parent if it has one. Anyone who can see the repository's work items may read it — on a public repository, without signing in; on a private one, a non-member gets not found. The number a work item had before it was moved returns it as it is now, with its new scope and number, to anyone who can read it there.

Parameters

Path
  • repo_idRepositoryId (string · uuid)Repository ID
  • issue_idIssueId (integer · int64)The per-scope iid — the work item's only identity

Responses

200The work itemapplication/json
  • created_atstring
  • created_byActorSummaryWho created the work item, as they were when they created it.
  • 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
  • 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-16T15:25:52Z",
"created_by": {
"email": "mara@acme.example",
"id": "id-9f65",
"username": "lin",
"avatar_url": "https://gitmoap.example/acme/1e3c7cb3"
},
"iid": 6,
"root_scope_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"scope_id": "158d5b00-ef5d-4b02-9298-51aa6ac22aab",
"scope_type": "group",
"status_category": "triage",
"status_id": "3a0de52b-26a2-4a33-ad54-9fdf291c43d0",
"title": "Pin a page's payload to the build that rendered it",
"uid": "44dfec83-4b46-41e7-99fb-9dbd88d75ff7",
"updated_at": "2026-10-11T09:50:40Z",
"work_item_type": "epic",
"ancestor_group_ids": [
"4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
],
"ancestor_issue_uids": [
"45bb511a-0974-41df-8bf9-d3e56b597398"
],
"assignee_ids": [
"d73eb740-a030-4a6c-a9ce-c4689543f2da"
],
"author_can_push": false,
"closed_at": "2026-10-12T03:38:38Z",
"closed_by": "a3f1c2d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"description": "Renders each region as density contours of its operations.",
"labels": [
"labels-f264",
"labels-e217"
],
"milestone_id": "b25bd2f8-4f92-4896-8e2b-b979e5087e32",
"milestone_scope_id": "e2252ad8-4d5f-44a6-9f34-b34708f3fc03",
"milestone_scope_type": "group",
"parent_ref": {
"iid": 66,
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
}
},
"parent_uid": "497ee77d-30cf-4492-bdad-b882d20c4354",
"points": 11,
"regressed_at": "2026-10-13T20:55:37Z",
"regressed_at_sha": "92d720504cc2d48e463d12fe66d780727e67d557",
"regressed_from_sha": "04b01ca74a618998b1e61da673dc87a070a26f5b",
"regressed_run_id": "9e2b7c41-3d5a-4f8e-b1c2-7a6d5e4f3c2b",
"severity": "critical",
"type_profile": {
"blueprint_id": "c7a0eac7-7e96-470e-bb13-971cff2b1b46",
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
}
},
"verification": "unverified",
"verified_at": "2026-10-12T16:21:48Z",
"verified_at_sha": "9a75b5e49b3b5860693db3bd1274d2a6e288dd56",
"verified_run_id": "9e2b7c41-3d5a-4f8e-b1c2-7a6d5e4f3c2b",
"version": 65
}
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-5c5b",
"message": "Inline scalar newtypes but keep their brand"
}
}
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-f134",
"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-5e28",
"message": "Stream pipeline status into the run header"
}
}
404Not found, or a private scope with no accessapplication/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-2ab2",
"message": "Pin a page's payload to the build that rendered it"
}
}

CLI

gitmoap issues get

  • --repo-ididRepository ID (id or owner/repo path)
  • --issue-ididThe per-scope iid — the work item's only identity

Used in these guides