Skip to content

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 โ€‹

NameInTypeRequiredDescription
idpathintegeryesGreater 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)

FieldTypeRequiredDescription
idintegeryes-
slugstringyes-
titlestringyes-
summarystring | nullyes-
descriptionstring | nullyes-
game_typestringyesOne of: "app", "game", "launcher"
statusstringyesOne of: "draft", "published", "hidden"
release_datestring | nullyesDate, YYYY-MM-DD.
controller_supportstringyesOne of: "none", "partial", "full"
websitestring | nullyes-
required_ageintegeryes-
legal_noticestring | nullyes-
license_requiredbooleanyes-
content_descriptionstring | nullyes-
metadataobjectyes-
created_atstringyesISO 8601 timestamp.
updated_atstringyesISO 8601 timestamp.
genre_idsinteger[]yes-
developer_idsinteger[]yes-
publisher_idsinteger[]yes-
media(object (StoreGameMedia))[]yes-
media[].idstring<uuid>yes-
media[].kindstringyesOne of: "header", "main_capsule", "small_capsule", "hero_capsule", "library_capsule", "library_hero"
media[].widthinteger | nullyes-
media[].heightinteger | nullyes-
media[].updated_atstringyesISO 8601 timestamp.
media[].urlstringyesPublic asset URL (cache-busted with ?t=).
screenshots(object (StoreGameScreenshot))[]yes-
screenshots[].idstring<uuid>yes-
screenshots[].widthinteger | nullyes-
screenshots[].heightinteger | nullyes-
screenshots[].updated_atstringyesISO 8601 timestamp.
screenshots[].urlstringyes-
screenshots[].thumbnail_urlstringyes-
runtime_apps(object (StoreGameRuntimeApp))[]yes-
runtime_apps[].idstring<uuid>yes-
runtime_apps[].game_idintegeryes-
runtime_apps[].runtime_app_idstringyesOpaque app id in the runtime.
runtime_apps[].labelstringyes-
runtime_apps[].is_defaultbooleanyes-
runtime_apps[].is_enabledbooleanyes-
runtime_apps[].sort_orderintegeryes-
runtime_apps[].created_atstringyesISO 8601 timestamp.
runtime_apps[].updated_atstringyesISO 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)

FieldTypeRequiredDescription
successbooleanyesOne of: false
errorobjectyes-
error.namestringyesOne of: "ZodError"
error.issuesobject[]yes-
error.issues[].codestringyes-
error.issues[].path(string | number)[]yes-
error.issues[].messagestringyes-

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)

FieldTypeRequiredDescription
errorstringyesStable machine-readable error code, e.g. forbidden, not_found.
detailsanynoOptional 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();

Try this endpoint

Requests go directly from your browser to the API. Send request executes this endpoint against the selected server.

GET/v1/admin/store/games/{id}

Your token stays in this tab's memory and is sent only when you press Send request.

Parameters

Built for developers. Ready for agents.