Skip to main content

ExerciseTemplate

An exercise template that can be used in workouts and routines.
export interface ExerciseTemplate {
  id: string;
  title: string;
  type: string;
  primary_muscle_group: string;
  secondary_muscle_groups: string[];
  is_custom: boolean;
}
id
string
required
Unique identifier for the exercise template
title
string
required
Title/name of the exercise
type
string
required
Type of exercise (e.g., “weight_reps”, “duration”, “distance”)
primary_muscle_group
string
required
Primary muscle group targeted by this exercise
secondary_muscle_groups
string[]
required
Array of secondary muscle groups targeted by this exercise
is_custom
boolean
required
Whether this is a custom exercise created by the user (true) or a Hevy default (false)

PaginatedExerciseTemplates

Paginated response containing multiple exercise templates.
export interface PaginatedExerciseTemplates {
  page: number;
  page_count: number;
  exercise_templates: ExerciseTemplate[];
}
page
number
required
Current page number (1-indexed)
page_count
number
required
Total number of pages available
exercise_templates
ExerciseTemplate[]
required
Array of exercise templates on this page

RoutineFolder

A folder for organizing routines.
export interface RoutineFolder {
  id: number;
  index: number;
  title: string;
  updated_at: string;
  created_at: string;
}
id
number
required
Unique identifier for the routine folder
index
number
required
Position/order of the folder (0-indexed)
title
string
required
Title/name of the folder
updated_at
string
required
ISO 8601 timestamp of last update
created_at
string
required
ISO 8601 timestamp of creation

PaginatedRoutineFolders

Paginated response containing multiple routine folders.
export interface PaginatedRoutineFolders {
  page: number;
  page_count: number;
  routine_folders: RoutineFolder[];
}
page
number
required
Current page number (1-indexed)
page_count
number
required
Total number of pages available
routine_folders
RoutineFolder[]
required
Array of routine folders on this page

Build docs developers (and LLMs) love