giip

CatQuest Data API Reference

🐾 Go to CatQuest page →

The CatQuest screen reads the giip issue-list API (giipIssues) and draws each issue as a cat card. This document explains how to query that data source directly via API, and how the screen maps status to cat behavior.

  • Host: https://giipfaw.azurewebsites.net
  • Auth: header x-api-key with the logged-in user's AK (or a project-scoped SK). The query scope is limited to the key's csn (project).
  • For the result code (RstVal) convention, see API Result Codes.

Query issue list — giipIssues GET

This is the read API CatQuest calls on page load.

curl "https://giipfaw.azurewebsites.net/api/giipIssues?csn=47" \
  -H "x-api-key: <YOUR_AK>"

Request parameters

NameInRequiredDescription
csnqueryProject number to query. CatQuest fills in the currently selected project's csn automatically.

Sample response

{
  "issues": [
    {
      "isn": 735,
      "title": "Create admin/catquest user guide",
      "status": "READY",
      "regdate": "2026-07-24T08:54:00Z",
      "summary": "Enable the guide button",
      "last_comment_date": "2026-07-24T09:00:00Z",
      "blocked_by_isn": null,
      "blocked_by_title": null
    }
  ]
}

Response fields (those CatQuest uses)

FieldTypeUse on screen
isnnumberIssue number (#isn badge). Also determines which cat is assigned.
titlestringSpeech-bubble title at the top of the card
statusstringDetermines the cat's behavior (animation) — see mapping below
regdatestringRegistered date (🐣)
summarystringSummary at the bottom of the card (when present)
last_comment_datestring | nullLast comment date (💬); "no comment" when null
blocked_by_isnnumber | nullBlocked-by badge — the number of the issue blocking this one
blocked_by_titlestring | nullTooltip of the blocked-by badge (blocking issue title)

Status → cat behavior mapping

The CatQuest frontend maps the status value to an animation with these rules (a display rule, not a server value).

statusCat stateImage file pattern
PENDINGplaying/images/catquest/<cat>_playing.png
READYready/images/catquest/<cat>_ready.png
IN_PROGRESShunting/images/catquest/<cat>_hunting.png
REVIEWdelivering/images/catquest/<cat>_delivering.png
DONEplaying/images/catquest/<cat>_playing.png
  • <cat> is one of 8 types (mochi, sherlock, nimbus, pixel, cocoa, midnight, luna, leo), assigned deterministically by isn % 8.

Related APIs

  • Create / update / change issue status: to create or transition issues programmatically, see Issue & Task APIs.
  • Query / add comments: the issue detail screen uses the giipIssueComments API.

Troubleshooting

SymptomCauseResolution
401 UnauthorizedMissing or expired x-api-keyCall again with a valid AK, or log in again.
Empty issues: []No issues for that csnCheck the csn value or register an issue.
Called without csnRequired parameter missingAlways include ?csn=<number>.

Version: 1.0 Last updated: 2026-07-24 Source file: giipv3/public/help/api-catquest.en.md