Skip to main content
GET
/
games
List public game catalog entries
curl --request GET \
  --url https://teambattles.gg/api/v1/games \
  --header 'Authorization: Bearer <token>'
{
  "games": [
    {
      "id": "<string>",
      "convexId": "<string>",
      "nameKey": "<string>",
      "shortNameKey": "<string>",
      "descriptionKey": "<string>",
      "category": "<string>",
      "rulesLink": "<string>",
      "coverImage": "<string>",
      "bannerImage": "<string>",
      "defaultTeamSize": 123,
      "hasCompetitiveMode": true,
      "isComingSoon": true,
      "isAvailableForMatchApi": true,
      "modes": [
        {
          "id": "<string>",
          "nameKey": "<string>",
          "descriptionKey": "<string>",
          "image": "<string>",
          "shortName": "<string>",
          "rewardBonus": 123,
          "supportsDraftToggle": true,
          "mapIds": [
            "<string>"
          ]
        }
      ],
      "maps": [
        {
          "id": "<string>",
          "nameKey": "<string>",
          "coverImage": "<string>",
          "minimapImage": "<string>",
          "isReleased": true
        }
      ],
      "playlists": [
        {
          "id": "<string>",
          "nameKey": "<string>",
          "descriptionKey": "<string>",
          "image": "<string>",
          "allowedGameModeIds": [
            "<string>"
          ]
        }
      ],
      "modeMapPools": [
        {
          "modeId": "<string>",
          "mapIds": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "objectives": [
    {
      "id": "<string>",
      "titleKey": "<string>",
      "descriptionKey": "<string>",
      "exp": 1,
      "scope": "<string>",
      "completionRule": "<string>"
    }
  ],
  "timestamp": "<string>"
}

Permission Required

This endpoint requires a valid API key, but no additional permission scope.

What’s Returned

Returns the public static game catalog, available objectives, and convexId for games that are active and available to match APIs.

Authorizations

Authorization
string
header
required

Send your API key as: Authorization: Bearer tb_

Response

Public game catalog.

Game catalog list response.

games
object[]
required
objectives
object[]
required
timestamp
string
required