コンテンツにスキップ
Retro Game Gather Logo Retro Game Gather Docsv2.2

コレクションのゲームと達成状況

POST
/rest/v1/getCollectionGames
curl --request POST \
  --url https://game.retrogather.com/rest/v1/getCollectionGames \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "collectionId": "example", "achieved": true, "platformIds": [ 1 ], "genreId": 1, "title": "example", "releaseDateFrom": "2026-04-15", "releaseDateTo": "2026-04-15", "sortBy": "title", "sortOrder": "asc", "page": 1, "limit": 1 }'

PREMIUM. Collection games / コレクションの達成状況: games in one collection, with achievement calculated on this call. summary is the unfiltered collection (totalGames, achievedGames, achievementRate, isCompleted). Default sort is releaseDate asc (same as the app). game is always included (page capped at 100). Tag and platform collections honor excludeGameIds. achievedAt is a date (play end date) or a datetime (library registration / play update). IDs that cannot be name-resolved are returned as game: { gameId } only.

Plans: PREMIUM. Scopes: library:read.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
collectionId
required

Target collection

string
achieved

True = achieved only, false = not yet

boolean
platformIds

Platform IDs (OR)

Array<integer>
<= 10 items
genreId

Genre ID from listGenres. A root ID matches the game’s genreId or genreSubId. A non-root ID matches titleKana using that genre’s taxonomy key.

integer
>= 1
title

Title, reading, or edition name

string
<= 30 characters
releaseDateFrom

Release date from (inclusive, YYYY-MM-DD). Games without a release date are excluded.

string format: date
releaseDateTo

Release date to (inclusive, YYYY-MM-DD). Games without a release date are excluded.

string format: date
sortBy
string
Allowed values: title releaseDate achievedAt
sortOrder

Asc or desc

string
Allowed values: asc desc
page
integer
>= 1
limit
integer
>= 1 <= 100

Responses

Section titled “ Responses ”

200

Section titled “200”

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

Media typeapplication/json
Any of:
object
items
required
Array<object>
object
gameId
required
integer
isAchieved
required
boolean
achievedAt
string
game
object
gameId
required
integer
title
string
titleEn
Array<string>
platform
object
platformId
required
integer
name
string
key
additional properties
any
publisher
object
companyId
required
integer
name
string
key
additional properties
any
genre
object
genreId
required
integer
name
string
key
additional properties
any
genreSub
object
genreId
required
integer
name
string
key
additional properties
any
releaseDate
string
custom
boolean
editions
Array<object>
object
gameEditionId
integer
title
string
modelNumber
Array<string>
releaseDate
string
price
number
janCode
string
key
additional properties
any
specs
object
modelNumber
Array<string>
price
number
janCode
string
key
additional properties
any
key
additional properties
any
key
additional properties
any
page
required
integer
returnedCount
required
integer
totalCount
required
integer
hasMore
required
boolean
effectiveLimit
integer
limitReduced
boolean
limitReason
string
summary
required
object
totalGames
required
integer
achievedGames
required
integer
achievementRate
required
number
isCompleted
required
boolean
key
additional properties
any
key
additional properties
any
Example
{
  "code": "plan_required",
  "status": "PLANNED",
  "items": [
    {
      "status": "added"
    }
  ]
}

400

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

401

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

403

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

404

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

429

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds

500

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

503

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds