Overview

⚠️ Pre-Release / Under Construction

This page is currently under active development and is provided in a pre-release state.

Content may be incomplete, outdated, or inaccurate, and details may changewithout notice as the implementation evolves.

Please use this documentation for early reference only, and avoid relying on it for production-critical decisions until the page is marked as stable.

Terra Planned Workouts API

Push structured workouts directly to your users' fitness devices.

Documentation

  1. Introduction & Quick Start - Get started in 5 minutes

  2. Core Concepts - Workout structure, blocks, steps, targets

  3. Athlete Parameters - Personalizing workouts per user

  4. Sport-Specific Examples - Running, cycling, swimming, strength

  5. Provider Compatibility - What works where

  6. Coercion Warnings - Handling feature limitations

  7. Exercise Reference - Garmin exercise names

  • OpenAPI Specification (to be added soon)

  • Garmin Exercise Names reference

API Endpoints

Method
Endpoint
Description

POST

/workouts

Create workout template

GET

/workouts

List all templates

GET

/workouts/{id}

Get template details

DELETE

/workouts/{id}

Delete template

POST

/workouts/{id}/plan?user_id=X

Schedule workout to user

GET

/plannedWorkouts/{id}

Get planned workout details

GET

/plannedWorkouts?user_id=X

List user's scheduled workouts (optional: start_date, end_date)

PATCH

/plannedWorkouts/{id}?user_id=X

Update scheduled date (only planned_date, not athlete params)

DELETE

/plannedWorkouts/{id}?user_id=X

Remove scheduled workout

Deleting a workout template cascades to all scheduled workouts

Last updated

Was this helpful?