機種の一覧

POST

/rest/v1/listPlatforms

curl --request POST \
  --url https://game.retrogather.com/rest/v1/listPlatforms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "page": 1, "limit": 1 }'

Platforms / 機種: list platforms in RGG coverage (page/limit, ordered by platformId). LIGHT/PREMIUM include platformId 500–599. Coverage: 日本発売レトロ機種のみ。

Plans: FREE / LIGHT / PREMIUM. Scopes: games:read.

Authorizations

• apiKey

Request Body

Media typeapplication/json

object

page

integer

>= 1

limit

integer

>= 1 <= 200

Example^generated

{
  "page": 1,
  "limit": 1
}

Responses

200

Tool result JSON (no MCP envelope). Delete previews also return 200 with confirmToken.

Media typeapplication/json

Any of:

object

object

items

required

Array<object>

object

platformId

required

integer

custom

boolean

key

additional properties

any

page

required

integer

returnedCount

required

integer

totalCount

required

integer

hasMore

required

boolean

effectiveLimit

integer

limitReduced

boolean

limitReason

string

key

additional properties

any

object

object

code

required

string

Allowed values: plan_required not_found invalid_input unavailable already_exists revision_conflict insufficient_scope

message

string

upgradeUrl

string

field

string

allowedValues

Array<string>

scope

string

additionalScopesRequired

Array<string>

playId

string

saved

boolean

physicalId

string

physicalIds

Array<string>

createdPhysicalIds

Array<string>

deletedId

string

status

string

Allowed values: PLANNED PLAYING PAUSED COMPLETED DROPPED

items

Array<object>

object

gameId

required

integer

status

required

string

Allowed values: added already_in_library not_found

fromWishlist

boolean

key

additional properties

any

limit

object

max

required

integer

current

required

integer

requested

required

integer

key

additional properties

any

key

additional properties

any

Example

{
  "code": "plan_required",
  "status": "PLANNED",
  "items": [
    {
      "status": "added"
    }
  ]
}

400

Invalid_input (arguments, broken JSON body)

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

401

Missing or invalid API key

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

403

Insufficient_scope, plan_required, or access_suspended

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

404

Target or tool not found

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

429

Burst or daily quota exceeded. See resetAt.

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

Headers

Retry-After

integer

Seconds

500

Unexpected server failure. Retrying the same call will not help.

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

503

Temporary failure or maintenance. Retry after Retry-After.

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

Headers

Retry-After

integer

Seconds