コンテンツにスキップ

コース

コースの一覧・詳細と、プレイヤーのコース記録を取得するAPIです。

削除済みを除く全コースを、コースクラスと公式IDの順で取得します。

リクエスト:

GET /v1/courses
Authorization: Bearer <APIトークン>

レスポンス: 200 OK

{
"courses": [
{
"id": "7d5f5c42b9a8e301",
"idx": "50020",
"name": "クラス認定 Ⅲ",
"class": "3"
}
]
}
フィールド型説明
coursesarrayコース情報の配列
courses[].idstringコースのID(16文字の小文字16進数)
courses[].idxstring公式ID
courses[].namestringコース名
courses[].classstringコースクラス(1~5、inf、extra)

指定されたコースの詳細を取得します。

リクエスト:

GET /v1/courses/7d5f5c42b9a8e301
Authorization: Bearer <APIトークン>

パスパラメータ:

パラメータ型説明
idstringコースのID(16文字の小文字16進数)

レスポンス: 200 OK

{
"id": "7d5f5c42b9a8e301",
"idx": "50020",
"name": "クラス認定 Ⅲ",
"class": "3"
}

フィールドの詳細は GET /v1/courses を参照してください。

エラー:

コードHTTP説明
validation_failed422id の形式が不正です
not_found404指定されたコースが見つかりません

指定されたユーザーのコースレコードを取得します。未プレイのコースも常に補完して返します(is_played が false、score が 0、updated_at が null)。追加のクエリパラメータは不要です。

プライバシーについて: 非公開設定のユーザーは、本人または承認済みフレンド以外からのリクエストに対して 404 Not Found を返します。

リクエスト:

GET /v1/users/kjumanenobikto/records/courses
Authorization: Bearer <APIトークン>

パスパラメータ:

パラメータ型説明
usernamestring対象ユーザー名

レスポンス: 200 OK

{
"updated_at": "2026-07-14T15:30:00+09:00",
"courses": [
{
"id": "7d5f5c42b9a8e301",
"idx": "50020",
"name": "クラス認定 Ⅲ",
"class": "3",
"is_played": true,
"score": 3012345,
"is_clear": true,
"combo_lamp": "FULL COMBO",
"updated_at": "2026-07-13T20:12:34+09:00"
},
{
"id": "2a1076c9e51f84bd",
"idx": "50021",
"name": "クラス認定 Ⅳ",
"class": "4",
"is_played": false,
"score": 0,
"is_clear": false,
"combo_lamp": null,
"updated_at": null
}
]
}
フィールド型説明
updated_atstring | nullコースマスタまたは対象ユーザーのコースレコードの最終更新日時のうち新しい方。どちらも存在しない場合は null
coursesarrayコースレコードの配列。プレイヤー未連携の場合は空配列
courses[].idstringコースのID(16文字の小文字16進数)
courses[].idxstring公式ID
courses[].namestringコース名
courses[].classstringコースクラス(1~5、inf、extra)
courses[].is_playedbooleanプレイ済みかどうか
courses[].scorenumberコーススコア(未プレイの場合は 0)
courses[].is_clearbooleanクリア済みかどうか
courses[].combo_lampstring | nullコンボランプ。未設定または NONE の場合は null
courses[].updated_atstring | nullレコード更新日時。未プレイの場合は null

エラー:

コードHTTP説明
user_not_found404ユーザーが見つからない、または非公開設定のため閲覧できません