> ## Documentation Index > Fetch the complete documentation index at: https://docs.framesports.ai/llms.txt > Use this file to discover all available pages before exploring further. # List events for a game (deprecated — use `/api/v1/fixtures/{fixture_id}/events`) > **Deprecated.** Use `GET /api/v1/fixtures/{fixture_id}/events` instead, which returns events across both sides of the match and resolves each event's team + player into prefix IDs. Paginated list of tagged events in a game (tackles, carries, rucks, tries, etc.). Results are scoped to events visible to the current account — events from other billing accounts on the same fixture are hidden. ## OpenAPI ````yaml /api-reference/openapi.yaml get /api/v1/games/{game_id}/events openapi: 3.0.3 info: title: Framesports API version: 1.0.0 description: > The Framesports API exposes read access to the same domain model used by the product: **accounts**, **fixtures**, **games**, and **events**. This reference documents the v1 surface. It is intentionally small — the API is used primarily by a small number of integration partners (e.g. broadcast-graphics tooling). If you need a capability that is not listed here, contact `support@framesports.ai` before building around private endpoints. ### Base URL ``` https://app.framesports.ai ``` ### Authentication All endpoints (except `POST /api/v1/auth` and `POST /api/v1/users`) require a bearer token in the `Authorization` header: ``` Authorization: Bearer ``` To get a token, sign in to Framesports and open [API tokens](https://2.framesports.ai/settings/my/api_tokens). Choose **Create token**, give it a name, pick the club it is for and how long it lasts. The token is shown once, so copy it straight away. The same page shows the club's account ID and lists your tokens, and **Delete token** stops one on its next request. A token acts as the person who made it; every request has their access. ### Account scoping Most endpoints are scoped to a single account (the multi-tenant unit — a club or governing body). The account is selected in priority order: 1. The `Account-Id` header on the request (prefix ID, e.g. `acct_Ex4mpLeAcc0unt1d567890`). The user must have access to that account directly, or through a governance relationship to it. 2. Otherwise, the club the token was made for. 3. Otherwise, the account stored in the user's session (for browser-originated calls). 4. Otherwise, the user's newest / fallback account. > **Note on the header name.** The server currently reads `Account-Id`, not > `X-Account-Id`. If you send `X-Account-Id`, it is silently ignored and the > request falls back to rule 2 or later, which may not be the account you intended. Responses when the header is present but invalid: | Situation | Status | | --- | --- | | Account does not exist | `404 Not Found` | | Account exists but the user cannot access it | `403 Forbidden` | ### IDs Object IDs in the API are always **prefix IDs** — an opaque string with a type-specific prefix: | Type | Prefix | Example | | --- | --- | --- | | Account | `acct_` | `acct_Ex4mpLeAcc0unt1d567890` | | Fixture | `fxt_` | `fxt_Ex4mpLeF1xtur31d34567890` | | Game | `game_` | `game_Ex4mpLeG4m31d4567890abc` | | Event | `evnt_` | `evnt_Ex4mpLe3v3nt1d4567890ab` | | Team | `team_` | `team_Ex4mpLeTe4m1d4567890abc` | | Player | `pl_` | `pl_Ex4mpLePL4y3r1d4567890abc` | | Player game involvement | `pgi_` | `pgi_Ex4mpLePG1nv0Lv3m3nt4aa` | Never pass raw integer IDs — the API only accepts prefix IDs for public lookups. ### Pagination List endpoints use [Pagy](https://ddnexus.github.io/pagy/) with JSON:API-style links. Pass `page` and `per_page` as query parameters (or use the URLs in the `links` object of the response): ```json { "links": { "first": "/api/v1/games/.../events?page[page]=1", "last": "/api/v1/games/.../events?page[page]=9", "prev": null, "next": "/api/v1/games/.../events?page[page]=2" }, "data": [ /* ... */ ] } ``` ### Errors Errors are returned with an appropriate HTTP status and (usually) a JSON body of the form `{"error": "..."}`. Unauthenticated responses (`401`) currently return an empty body with `content-type: text/html` — treat any `401` as "token missing or invalid" regardless of body. ### Versioning & stability The `/api/v1/` prefix denotes a stable version of the API. Fields may be **added** without notice; fields will not be **removed** or change meaning without a new major version. Any field whose object includes `"deprecated": true` is scheduled for removal — migrate off it. contact: name: Framesports support email: support@framesports.ai servers: - url: https://app.framesports.ai description: Production security: - bearerAuth: [] tags: - name: Authentication description: Exchange credentials for an API token, or invalidate the current session. - name: Accounts description: The accounts the authenticated user can access. - name: Me description: The authenticated user. - name: Fixtures description: | A fixture is a single rugby match with two sides. Each side carries the team that played, the roster that took the field, and the full set of team-level stats. This is the endpoint to use for broadcast graphics, season roll-ups, or anything else that wants "the match" as a single object. - name: Games description: | **Deprecated — prefer `Fixtures`.** A game represents one side of a fixture (the billing account's own side). The `/api/v1/games` endpoints are kept for backwards compatibility; new integrations should consume `/api/v1/fixtures` instead, which returns both sides and all stats in one payload. - name: Events description: | Tagged plays within a fixture (tackles, carries, tries, etc.). Prefer `GET /api/v1/fixtures/{fixture_id}/events`, which spans both sides of the match and resolves each event's team + player into prefix IDs. The `/api/v1/games/{game_id}/events` endpoint is kept for backwards compatibility — it returns only one side and leaves you to map `"Home"` / `"Opp"` + jersey numbers yourself. paths: /api/v1/games/{game_id}/events: get: tags: - Events summary: >- List events for a game (deprecated — use `/api/v1/fixtures/{fixture_id}/events`) description: | **Deprecated.** Use `GET /api/v1/fixtures/{fixture_id}/events` instead, which returns events across both sides of the match and resolves each event's team + player into prefix IDs. Paginated list of tagged events in a game (tackles, carries, rucks, tries, etc.). Results are scoped to events visible to the current account — events from other billing accounts on the same fixture are hidden. operationId: listGameEvents parameters: - $ref: '#/components/parameters/AccountIdHeader' - in: path name: game_id required: true schema: type: string example: game_Ex4mpLeG4m31d4567890abc - in: query name: page description: Page number (1-based). schema: type: integer minimum: 1 default: 1 - in: query name: per_page description: Items per page. Default is Pagy's default (20). schema: type: integer minimum: 1 maximum: 100 default: 20 responses: '200': description: Events page. content: application/json: schema: type: object required: - data - links properties: data: type: array items: $ref: '#/components/schemas/Event' links: $ref: '#/components/schemas/PaginationLinks' '401': $ref: '#/components/responses/Unauthorized' '404': description: Game not found or not accessible to the current account. deprecated: true components: parameters: AccountIdHeader: in: header name: Account-Id required: false description: | Prefix ID of the account to scope this request to. Settings → API tokens shows it next to each token. If omitted, the server uses the club the token was made for (then the session account, then the newest account). Must be `Account-Id`: `X-Account-Id` is not read. schema: type: string example: acct_Ex4mpLeAcc0unt1d567890 schemas: Event: type: object description: | Legacy event shape returned by the deprecated `GET /api/v1/games/{game_id}/events` endpoint. Prefer `FixtureEvent` — same data with team + player resolved. properties: id: type: string example: evnt_Ex4mpLe3v3nt1d4567890ab caption: type: string description: > Human-readable event description (e.g. `"Dominant Carry"`, `"Tackle Missed"`, `"Try"`). See `docs/codebook/` in the Framesports repo for the full caption vocabulary and rate formulas. example: Dominant Carry player_number: type: integer nullable: true description: >- Jersey number of the player the event is attributed to (null for team events like tries conceded). team: type: string enum: - Home - Opp description: Which side of the fixture the event belongs to. start_timestamp: type: integer description: Milliseconds into the video at which the event starts. end_timestamp: type: integer description: Milliseconds into the video at which the event ends. PaginationLinks: type: object properties: first: type: string nullable: true last: type: string nullable: true prev: type: string nullable: true next: type: string nullable: true responses: Unauthorized: description: Token missing or invalid. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: opaque description: | Create a token on **Settings → API tokens** in Framesports. It is shown once, when you create it. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.