CatQuest Data API Reference
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-keywith the logged-in user's AK (or a project-scoped SK). The query scope is limited to the key'scsn(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
| Name | In | Required | Description |
|---|---|---|---|
csn | query | ✅ | Project 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)
| Field | Type | Use on screen |
|---|---|---|
isn | number | Issue number (#isn badge). Also determines which cat is assigned. |
title | string | Speech-bubble title at the top of the card |
status | string | Determines the cat's behavior (animation) — see mapping below |
regdate | string | Registered date (🐣) |
summary | string | Summary at the bottom of the card (when present) |
last_comment_date | string | null | Last comment date (💬); "no comment" when null |
blocked_by_isn | number | null | Blocked-by badge — the number of the issue blocking this one |
blocked_by_title | string | null | Tooltip 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).
| status | Cat state | Image file pattern |
|---|---|---|
| PENDING | playing | /images/catquest/<cat>_playing.png |
| READY | ready | /images/catquest/<cat>_ready.png |
| IN_PROGRESS | hunting | /images/catquest/<cat>_hunting.png |
| REVIEW | delivering | /images/catquest/<cat>_delivering.png |
| DONE | playing | /images/catquest/<cat>_playing.png |
<cat>is one of 8 types (mochi, sherlock, nimbus, pixel, cocoa, midnight, luna, leo), assigned deterministically byisn % 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
giipIssueCommentsAPI.
Troubleshooting
| Symptom | Cause | Resolution |
|---|---|---|
401 Unauthorized | Missing or expired x-api-key | Call again with a valid AK, or log in again. |
Empty issues: [] | No issues for that csn | Check the csn value or register an issue. |
Called without csn | Required parameter missing | Always include ?csn=<number>. |
Version: 1.0
Last updated: 2026-07-24
Source file: giipv3/public/help/api-catquest.en.md