API reference

Every endpoint of the Vitruve API, grouped by resource, with parameters, fields and example requests and responses.

All endpoints live under https://api-next.vitruve.fit/v1 and need the X-API-Key header. Most are GET. The POST, PATCH, PUT and DELETE endpoints need your organization's own API key: see Writes. Lists are paginated and share the filtering conventions.

Organization and peopleOrganization, athletes, sport profiles, coaches, teams. Writes athletes, coach assignments and teams.TrainingWorkouts with their full tree, and programs.TemplatesReusable workouts, phases, blocks and prescriptions.MeasurementsLoad-velocity profiles, leaderboards, wellness, injuries. Writes profiles and injury reports.AnalyticsMetric trends and athlete rankings, computed for you.CatalogsExercises, muscles, metrics, prescription types, units. Writes your own exercises.Health checksLiveness and readiness probes.

Reading an endpoint

Each endpoint shows its description and parameters on the left. On the right, a request you can copy in cURL, JavaScript or Python (your language choice is remembered), and the response you will get. Lists show a trimmed example: real responses hold up to limit items.

Responses use the shared envelope. Failures are listed in Error codes.

Workout data model

How a workout nests from blocks down to repetitions, and how prescribed and executed values relate.

Organization and people

Read your organization, its athletes with their sport profile, coaches and teams. Create, update and delete athletes and teams, and choose which athletes each coach sees.

On this page

Reading an endpoint