Appearance
Get a game with art and runtime apps โ
GET /v1/admin/store/games/{id}
- Operation ID:
getStoreGame - Tags: Store games
- Base URL:
http://localhost:8787
Workflow: Integration guide.
Authentication: staff Bearer JWT with permission store.read.
Authentication โ
- Auth: staff Bearer JWT (
Authorization: Bearer <access_token>) with the permissions below. - Required permissions:
store.read
Parameters โ
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | yes | Greater than: 0 |
Responses โ
200 โ
Game detail.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (StoreGameDetail)
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | yes | - |
slug | string | yes | - |
title | string | yes | - |
summary | string | null | yes | - |
description | string | null | yes | - |
game_type | string | yes | One of: "app", "game", "launcher" |
status | string | yes | One of: "draft", "published", "hidden" |
release_date | string | null | yes | Date, YYYY-MM-DD. |
controller_support | string | yes | One of: "none", "partial", "full" |
website | string | null | yes | - |
required_age | integer | yes | - |
legal_notice | string | null | yes | - |
license_required | boolean | yes | - |
content_description | string | null | yes | - |
metadata | object | yes | - |
created_at | string | yes | ISO 8601 timestamp. |
updated_at | string | yes | ISO 8601 timestamp. |
genre_ids | integer[] | yes | - |
developer_ids | integer[] | yes | - |
publisher_ids | integer[] | yes | - |
media | (object (StoreGameMedia))[] | yes | - |
media[].id | string<uuid> | yes | - |
media[].kind | string | yes | One of: "header", "main_capsule", "small_capsule", "hero_capsule", "library_capsule", "library_hero" |
media[].width | integer | null | yes | - |
media[].height | integer | null | yes | - |
media[].updated_at | string | yes | ISO 8601 timestamp. |
media[].url | string | yes | Public asset URL (cache-busted with ?t=). |
screenshots | (object (StoreGameScreenshot))[] | yes | - |
screenshots[].id | string<uuid> | yes | - |
screenshots[].width | integer | null | yes | - |
screenshots[].height | integer | null | yes | - |
screenshots[].updated_at | string | yes | ISO 8601 timestamp. |
screenshots[].url | string | yes | - |
screenshots[].thumbnail_url | string | yes | - |
runtime_apps | (object (StoreGameRuntimeApp))[] | yes | - |
runtime_apps[].id | string<uuid> | yes | - |
runtime_apps[].game_id | integer | yes | - |
runtime_apps[].runtime_app_id | string | yes | Opaque app id in the runtime. |
runtime_apps[].label | string | yes | - |
runtime_apps[].is_default | boolean | yes | - |
runtime_apps[].is_enabled | boolean | yes | - |
runtime_apps[].sort_order | integer | yes | - |
runtime_apps[].created_at | string | yes | ISO 8601 timestamp. |
runtime_apps[].updated_at | string | yes | ISO 8601 timestamp. |
Errors โ
400 โ
Request validation failed.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ValidationErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | yes | One of: false |
error | object | yes | - |
error.name | string | yes | One of: "ZodError" |
error.issues | object[] | yes | - |
error.issues[].code | string | yes | - |
error.issues[].path | (string | number)[] | yes | - |
error.issues[].message | string | yes | - |
Request validation
json
{
"success": false,
"error": {
"name": "ZodError",
"issues": [
{
"code": "custom",
"path": [
"field"
],
"message": "Invalid value"
}
]
}
}401 โ
Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | Stable machine-readable error code, e.g. forbidden, not_found. |
details | any | no | Optional structured context. For 403 it is { perm }. |
Error response
json
{
"error": "missing_token"
}403 โ
Authenticated but lacking the required permission. details.perm lists the accepted permission keys.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "forbidden",
"details": {
"perm": "store.read"
}
}404 โ
game_not_found.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "game_not_found"
}500 โ
Unexpected server error (internal). No details are returned.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "internal"
}Examples โ
curl โ
bash
curl -X GET 'http://localhost:8787/v1/admin/store/games/1' \
-H "Authorization: Bearer $ACCESS_TOKEN"TypeScript โ
ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow
const response = await fetch("http://localhost:8787/v1/admin/store/games/1", {
method: "GET",
headers: {
"Authorization": `Bearer ${accessToken}`,
},
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
? undefined
: response.headers.get("content-type")?.includes("json")
? await response.json()
: await response.text();