IssueCard
A work item as a board or backlog shows it: the item with its author, assignees, labels, milestone, children's progress and counts resolved.
Shape
assigneesarray of ActorSummary
- The ActorSummary schema
- emailstring
- idstring
- usernamestring
- avatar_urlstring or nulloptional
authorActorSummary
- The ActorSummary schema
- emailstring
- idstring
- usernamestring
- avatar_urlstring or nulloptional
- blocked_byinteger · int320–∞How many open work items block this one. A count, never an identity: a blocker the caller cannot see still blocks, and naming it would leak the private item's existence.
childrenIssueRollupThe progress of the item's children. All zeros when it has none.
- The IssueRollup schema
- cancelledinteger · int320–∞
childrenarray of IssueChildLink
- The IssueChildLink schema
child_refIssueRefThe child's current address: the group or repository it lives in, and its number there.
- The IssueRef schema
- iidIssueId (integer · int64)
- scopeScopeRef
- child_uidIssueUid (string · uuid)The child's permanent identifier.
- linked_atstring
- status_categoryStatusCategorytriagetodoin_progressin_reviewblockeddonecancelledThe status category the child 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–∞
- completedinteger · int320–∞Children in the
donecategory only. A cancelled child is closed but not completed, and is counted incancelled. - openinteger · int320–∞
- points_completedinteger · int320–∞
- points_totalinteger · int320–∞
- totalinteger · int320–∞
- comments_countinteger · int320–∞
- created_atstring
- iidIssueId (integer · int64)
labelsarray of CardLabel
- The CardLabel schema
- colorLabelColor (string)
- keyLabelKey (string)
- scopeScopeRef
- status_categoryStatusCategorytriagetodoin_progressin_reviewblockeddonecancelledThe fixed category behind a status. A status also has a name, which the team owns and may rename freely; the category is the part the platform reasons about. A team can call a status "Ready for QA" and the platform still knows it is
in_review— so a board can place it in a column, a merge can move it, and a progress rollup can count it as not done. - status_idStatusId (string)
- titleIssueTitle (string)
- uidIssueUid (string · uuid)
- updated_atstring
- verificationVerificationStateunverifiedverifiedregressedWhether CI has proved the work item's acceptance criteria.
unverifieduntil a pipeline run proves them,verifiedonce one has, andregressedwhen a later run shows that evidence no longer holds. - 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.
- 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.
milestoneCardMilestone or nulloptional
- The CardMilestone schema
- milestone_idMilestoneId (string · uuid)
- titleMilestoneTitle (string)
- pointsinteger · int32 or nulloptional0–∞
- severitySeveritycriticalhighmediumlowor nulloptional
Example
Synthesized example{
"assignees": [
{
"email": "mara@acme.example",
"id": "id-52d6",
"username": "tomas"
}
],
"author": {
"email": "mara@acme.example",
"id": "id-d37a",
"username": "lin",
"avatar_url": "https://gitmoap.example/acme/084d8236"
},
"blocked_by": 65,
"children": {
"cancelled": 15,
"children": [
{
"child_ref": {
"iid": 56,
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
}
},
"child_uid": "900dc047-3176-41e7-8f2e-e3f4fd3abe9f",
"linked_at": "2026-10-16T20:12:36Z",
"status_category": "triage",
"work_item_type": "epic"
},
{
"child_ref": {
"iid": 38,
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
}
},
"child_uid": "ee7795ff-6a5e-47bb-a69a-546222c5330b",
"linked_at": "2026-10-09T22:16:48Z",
"status_category": "triage",
"work_item_type": "epic"
}
],
"completed": 42,
"open": 68,
"points_completed": 33,
"points_total": 2,
"total": 2
},
"comments_count": 6,
"created_at": "2026-10-15T11:46:53Z",
"iid": 4,
"labels": [
{
"color": "color-5e4b",
"key": "key-9c23"
},
{
"color": "color-e7d7",
"key": "key-f986"
}
],
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
},
"status_category": "triage",
"status_id": "22c4106e-a0f3-4616-aaca-e1c6c9f8fa1a",
"title": "Inline scalar newtypes but keep their brand",
"uid": "c7edf643-7265-4ab6-9410-727f6c483848",
"updated_at": "2026-10-12T12:45:57Z",
"verification": "unverified",
"work_item_type": "epic",
"author_can_push": false,
"milestone": {
"milestone_id": "49f7fc18-6619-4413-a98f-a2126d11b067",
"title": "Stream pipeline status into the run header"
},
"points": 4,
"severity": "critical"
}
Graph
Used inside
No schema contains this one.
Used by
Sent by 0 operations
No operation takes it as a request body.
Returned by 0 operations
No operation returns it directly.