Skip to main content
The Public API lets you read and write SquadVault data for an organization using API keys. Use it for scripts, bots, Discord tooling, and internal integrations.

​
Base URL

All Public API endpoints live under /v1. Organization API keys only work on this versioned path. App proxy paths without /v1 are for the SquadVault dashboard (session auth) and are not the integration contract. Production integrations should always use https://api.squadvault.xyz/v1.

​
What you can do

Calendar, tasks, availability, and Discord management are not part of this Public API surface yet.

​
Organization ID

The API key is scoped to one organization, but most operations still require that organization’s ID. It must match the key. Missing or mismatched IDs return 400 invalidRequest or 403 forbidden. Team, player, and document update/delete/download resolve the organization from the resource ID. Tryout get, update, and convert do not — always send organizationId.

​
Prerequisites

  1. An organization on a plan that includes API access.
  2. An organization API key from Integrations → API keys.
  3. Permissions on the key that match the endpoints you call.

​
Quick example

​
Next

Authentication

Send organization API keys with every request.

Permissions

Match key permissions to each endpoint.