Skip to main content

​
List games

GET /api/v1/games
Returns all non-archived games for the current account. 
curl https://app.framesports.com/api/v1/games \
  -H "Authorization: Bearer your-api-token"
Response
{
  "data": [
    {
      "id": "game_abc123",
      "name": "Brothers vs GPS",
      "own_team": {
        "id": "team_def456",
        "name": "Brothers 1sts",
        "jersey_description": "Red"
      },
      "opp_team": {
        "id": "team_ghi789",
        "name": "GPS 1sts",
        "jersey_description": "Blue"
      },
      "analysis_status": "completed",
      "event_count": 142,
      "created_at": "2024-06-01T10:00:00.000Z",
      "updated_at": "2024-06-02T14:30:00.000Z"
    }
  ],
  "account": {
    "id": "acct_abc123",
    "name": "Brothers Rugby Club"
  }
}

​
Response fields

FieldTypeDescription
idstringPrefixed game ID
namestringMatch name
own_teamobjectYour team’s details (id, name, jersey_description)
opp_teamobjectOpposition team’s details
analysis_statusstringOne of pending, in_progress, completed
event_countintegerNumber of tagged events
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp
The response also includes an account object confirming which account’s data was returned.

​
Get a game

GET /api/v1/games/:id
Returns a single game with its player list. 
curl https://app.framesports.com/api/v1/games/game_abc123 \
  -H "Authorization: Bearer your-api-token"
Response
{
  "id": "game_abc123",
  "name": "Brothers vs GPS",
  "own_team": {
    "id": "team_def456",
    "name": "Brothers 1sts",
    "jersey_description": "Red"
  },
  "opp_team": {
    "id": "team_ghi789",
    "name": "GPS 1sts",
    "jersey_description": "Blue"
  },
  "analysis_status": "completed",
  "event_count": 142,
  "created_at": "2024-06-01T10:00:00.000Z",
  "updated_at": "2024-06-02T14:30:00.000Z",
  "players": [
    {
      "id": "pl_xyz789",
      "name": "John Smith",
      "jersey_number": 7
    }
  ]
}

​
Player fields

FieldTypeDescription
idstringPrefixed player ID (may be null if unlinked)
namestringPlayer name
jersey_numberintegerJersey number in this game