Skip to content

Card API

{PROJECT_ABBREVIATION}-{TYPE_CODE}-{NUMBER}
TypeCodeExample
TaskTSKPLN-TSK-0042
BugBUGPLN-BUG-0015
EpicPCSPLN-PCS-0003
SprintSPRPLN-SPR-0001
ProposalPRPPLN-PRP-0001
QAQAIPLN-QAI-0001

All card types share these fields:

FieldTypeDescription
cardIdstringAuto-generated unique ID
cardTypestring”task-card”, “bug-card”, “epic-card”, etc.
titlestringCard title
statusstringCurrent status
projectIdstringParent project
yearnumberYear for filtering
createdAtstringISO timestamp
createdBystringCreator identifier
firebaseIdstringFirebase RTDB push key
FieldTypeDescription
descriptionStructuredarray[{role, goal, benefit}] — User story
acceptanceCriteriaStructuredarray[{given, when, then}] — Gherkin
devPointsnumberTechnical effort (1-5)
businessPointsnumberBusiness value (1-5)
prioritynumberAuto-calculated: (bizPts/devPts) × 100
developerstringAssigned developer ID (dev_XXX)
codeveloperstringCo-developer ID
validatorstringAssigned validator ID (stk_XXX)
sprintstringSprint ID (e.g., PLN-SPR-0001)
epicstringEpic ID (e.g., PLN-PCS-0003)
startDatestringWhen work started (ISO)
endDatestringWhen work finished (ISO)
commitsarray[{hash, message, date, author}]
pipelineStatusobjectPipeline tracking events
implementationPlanobjectPre-implementation plan
aiUsagearrayAI agent usage tracking
FieldTypeDescription
descriptionstringPlain text description
prioritystringOne of the 6 bug priority levels
registerDatestringWhen bug was reported
rootCausestringRoot cause analysis (on close)
resolutionstringHow it was resolved (on close)
To Do → In Progress → To Validate → Done → Done&Validated
↘ Blocked
Reopened → In Progress
Created → Assigned → Fixed → Verified → Closed
/cards/{projectName}/{cardType}_{projectName}/{cardId}/

Example: /cards/PlanningGame/task-card_PlanningGame/-OmXyz123/