Quickstart
Create an API key and read your first athletes and workouts in five minutes.
Create an API key
You must be an Owner of an organization on the Professional plan. In the Vitruve app open Settings → API Access, select +, name the key after the tool that will use it, and save. Copy the key.
Treat the key like a password
Keep it in an environment variable or a secrets manager. Never commit it or ship it in a browser or mobile app: anyone holding it can read and change your organization's data.
Check the key works
export VITRUVE_API_KEY="paste-your-key-here"
curl "https://api-next.vitruve.fit/v1/organization" \
-H "X-API-Key: $VITRUVE_API_KEY"A 200 with your organization in data means you are set. A 401 means the key is missing, mistyped or revoked: see error codes. A 403 means the organization's plan does not include the API: see Plans and access.
List your athletes
curl "https://api-next.vitruve.fit/v1/athletes?limit=5" \
-H "X-API-Key: $VITRUVE_API_KEY"Every list has the same envelope: data holds the items, meta tells you whether there is another page. Copy an athlete id for the next step.
Read their latest workouts
curl "https://api-next.vitruve.fit/v1/workouts?userId=ATHLETE_ID&limit=3" \
-H "X-API-Key: $VITRUVE_API_KEY"The list returns workouts without their content. Fetch one workout with GET /workouts/{id} to get blocks, sets and every repetition. See the workout data model.
Next
- Read more than one page: Pagination
- Turn ids into names: IDs and relations
- Handle failures and limits: Errors, Rate limits
- Export everything: Export all workouts
- Push changes into Vitruve: Writes
Vitruve API
A REST API for your organization's Vitruve data. Read athletes, workouts, repetitions, load-velocity profiles and more as JSON, and write what keeps Vitruve in sync with your systems.
Authentication
Authenticate every request with an organization API key in the X-API-Key header. Create, scope, rotate and revoke keys.