> ## Documentation Index
> Fetch the complete documentation index at: https://huddleup-sports.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Complete Whistle partner REST API reference — every endpoint, request and response schema, generated from the OpenAPI 3.1 specification.

The endpoint pages in the sidebar are generated from Whistle's OpenAPI 3.1 specification and document the complete v1 surface: 21 operations — the self-describing index plus 20 resource operations across leagues, games, officials, assignments, payments, and webhooks.

* **Raw spec:** [`/docs/api-reference/openapi.json`](https://huddleup-sports.com/docs/api-reference/openapi.json) — pin and diff it in CI to detect surface changes.
* **Base URL:** `https://whistle.huddleup-sports.com/api/v1`
* **Auth:** `Authorization: Bearer whk_…` on every request — see [Authentication](/developers/authentication).
* **Envelope:** success `{"data": …}`, error `{"error": "<code>"}` — see [Errors & agent safety](/developers/errors-and-agent-safety).

The spec also declares all 12 webhook event payloads under its `webhooks` section — the narrative guide is on the [Webhooks page](/developers/webhooks).
