コンテンツにスキップ

コレクションの一覧

POST
/rest/v1/getCollections
curl --request POST \
--url https://game.retrogather.com/rest/v1/getCollections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "purposeTypes": [ "LIBRARY" ], "collectionTypes": [ "INDIVIDUAL" ], "name": "example", "sortBy": "priority", "sortOrder": "asc", "page": 1, "limit": 1, "fields": [ "conditions" ] }'

PREMIUM. Collections / コレクション: list collections with page/limit. Default sort is priority desc (same as the app). Achievement is not included — use getCollectionGames. revision is always returned for member replace.

Plans: PREMIUM. Scopes: library:read.

Media typeapplication/json
object
purposeTypes
Array<string>
Allowed values: LIBRARY PLAY
collectionTypes
Array<string>
Allowed values: INDIVIDUAL TAG PLATFORM
name

Collection name (substring, case-insensitive)

string
<= 30 characters
sortBy
string
Allowed values: priority name createdAt updatedAt
sortOrder

Asc or desc

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

Optional groups. Omit for default (source). [] returns core fields only (collectionId, name, collectionType, purposeType, priority, revision). conditions: requiredAttributes (labeled) and includeDroppedAsAchieved. source: tag {tagId,name} or platform {platformId,name} (omitted for INDIVIDUAL). details: nameKana, description. members: INDIVIDUAL gameIds or TAG/PLATFORM excludeGameIds. timestamps: createdAt, updatedAt. Achievement is not included; use getCollectionGames.

Array<string>
Allowed values: conditions source timestamps details members

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

Media typeapplication/json
Any of:
object
items
required
Array<object>
object
collectionId
required
string
name
required
string
collectionType
required
string
Allowed values: INDIVIDUAL TAG PLATFORM
purposeType
required
string
Allowed values: LIBRARY PLAY
priority
integer
revision
required
string
requiredAttributes
Array<object>
object
id
required
string
label
string
custom
boolean
key
additional properties
any
includeDroppedAsAchieved
boolean
tag
object
tagId
required
integer
name
string
key
additional properties
any
platform
object
platformId
required
integer
name
string
key
additional properties
any
nameKana
string
description
string
gameIds
Array<integer>
excludeGameIds
Array<integer>
createdAt
string
updatedAt
string
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
Example
{
"items": [
{
"collectionType": "INDIVIDUAL",
"purposeType": "LIBRARY"
}
]
}

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"
}

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"
}

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"
}

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"
}

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"
}
Retry-After
integer

Seconds

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"
}

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"
}
Retry-After
integer

Seconds