Intervals.icu
App · 20 actions
Read activities, wellness and gear, and manage calendar events and workout folders.
Actions
| Action | What it does |
|---|---|
| Create event | Create an event (planned workout, note etc.) on the athlete's calendar. |
| Create folder | Create a new workout folder or plan. |
| Create workout | Create a new workout in a folder or plan in the athlete's workout library. |
| Delete event | Delete an event (planned workout, notes etc.) from an athlete's calendar. |
| Delete folder | Delete a workout folder or plan including all workouts. |
| Delete workout | Delete only the selected workout from the library. |
| Get activity | Get an activity. |
| Get athlete | Get the athlete with sportSettings and custom_items. |
| Get event | Get an event (planned workout, note etc.). |
| Get wellness | Get wellness record for date (local ISO-8601 day). |
| Get workout | Get a workout. |
| List activities | List activities for a date range in desc date order. |
| List events | List events (planned workouts, notes etc.) on the athlete's calendar, add .csv for CSV output. |
| List folders | List all the athlete's folders, plans and workouts. |
| List gear | List athlete gear (use .csv for CSV format). |
| List routes | List routes for an athlete with activity counts. |
| List wellness | List wellness records for date range (use .csv for CSV format). |
| List workouts | List workouts. |
| Update event | Update an event (planned workout, note etc.). |
| Update wellness | Update the wellness record for the date (ISO-8601). |
Create event
Create an event (planned workout, note etc.) on the athlete's calendar.
Inputs
- Start date local
start_date_localdate and timeRequired - Start date local.
- Sport
typetext - Type.
- Category
categorytextRequired - Category.One of:
WORKOUT,RACE_A(Race a),RACE_B(Race b),RACE_C(Race c),NOTE,PLAN,HOLIDAY,SICK,INJURED,SET_EFTP(Set eftp), and 4 more. - End date local
end_date_localdate and time - End date local.
- Name
nametextRequired - Name.
- Description
descriptiontext - Description.
- Color
colortext - Color.
Outputs
dataobject- Intervals.icu response data.
Example output
{
"data": {
"athlete_cannot_edit": false,
"athlete_id": "example",
"atl_days": 1,
"attachments": [],
"calendar_id": 1,
"can_train_sports": [],
"carbs_per_hour": 1,
"carbs_used": 1,
"category": "WORKOUT",
"color": "example",
"created_by_id": "example",
"ctl_days": 1,
"description": "example",
"distance": 1.0,
"distance_target": 1.0,
"end_date_local": "example",
"entered": false,
"external_id": "example",
"for_week": false,
"hide_from_athlete": false,
"icu_atl": 1.0,
"icu_ctl": 1.0,
"icu_ftp": 1,
"icu_intensity": 1.0,
"icu_training_load": 1,
"id": 1,
"indoor": false,
"joules": 1,
"joules_above_ftp": 1,
"load_target": 1,
"max_training_time": 1,
"moving_time": 1,
"name": "example",
"not_on_fitness_chart": false,
"oauth_client_id": 1,
"p_max": 1,
"plan_applied": "example",
"plan_athlete_id": "example",
"plan_folder_id": 1,
"plan_workout_id": 1,
"push_errors": [],
"shared_event_id": 1,
"show_as_note": false,
"show_on_ctl_line": false,
"ss_cp": 1.0,
"ss_p_max": 1.0,
"ss_w_prime": 1.0,
"start_date_local": "example",
"strain_score": 1.0,
"structure_read_only": false,
"sub_type": "NONE",
"tags": [],
"target": "AUTO",
"time_target": 1,
"training_availability": "NORMAL",
"type": "example",
"uid": "example",
"updated": "example",
"w_prime": 1,
"workout_doc": {}
}
}Create folder
Create a new workout folder or plan.
Inputs
- Type
typetextRequired - Type.One of:
FOLDER,PLAN. - Name
nametextRequired - Name.
- Description
descriptiontext - Description.
Outputs
dataobject- Intervals.icu response data.
Example output
{
"data": {
"activity_types": [],
"athlete_id": "example",
"auto_rollout_day": 1,
"blurb": "example",
"canEdit": false,
"children": [],
"description": "example",
"duration_weeks": 1,
"hours_per_week_max": 1,
"hours_per_week_min": 1,
"id": 1,
"name": "example",
"num_workouts": 1,
"owner": {
"bio": "example",
"city": "example",
"country": "example",
"email": "example",
"id": "example",
"name": "example",
"profile_medium": "example",
"sex": "example",
"state": "example",
"timezone": "example",
"website": "example"
},
"read_only_workouts": false,
"rollout_weeks": 1,
"shareToken": "example",
"sharedWithCount": 1,
"start_date_local": "example",
"starting_atl": 1,
"starting_ctl": 1,
"type": "FOLDER",
"visibility": "PRIVATE",
"workout_targets": []
}
}Create workout
Create a new workout in a folder or plan in the athlete's workout library.
Inputs
- Name
nametextRequired - Name.
- Description
descriptiontextRequired - Description.
- Type
typetextRequired - Type.
- Folder
folder_idtextRequired - Folder ID.
Outputs
dataobject- Intervals.icu response data.
Example output
{
"data": {
"athlete_id": "example",
"attachments": [],
"carbs_per_hour": 1,
"color": "example",
"day": 1,
"days": 1,
"description": "example",
"distance": 1.0,
"folder_id": 1,
"for_week": false,
"hide_from_athlete": false,
"icu_intensity": 1.0,
"icu_training_load": 1,
"id": 1,
"indoor": false,
"joules": 1,
"joules_above_ftp": 1,
"moving_time": 1,
"name": "example",
"plan_applied": "example",
"sub_type": "NONE",
"tags": [],
"target": "AUTO",
"targets": [],
"time": "example",
"type": "example",
"updated": "example",
"workout_doc": {}
}
}Delete event
Delete an event (planned workout, notes etc.) from an athlete's calendar.
Inputs
- Event ID
eventIdtextRequired - Event ID.
Outputs
dataobject- Intervals.icu response data.
Example output
{
"data": {}
}Delete folder
Delete a workout folder or plan including all workouts.
Inputs
- Folder
folderIdtextRequired - Folder ID.
Outputs
dataobject- Intervals.icu response data.
Example output
{
"data": {}
}Delete workout
Delete only the selected workout from the library.
Inputs
- Workout ID
workoutIdtextRequired - Workout ID.
Outputs
datalist- Intervals.icu response data.
Example output
{
"data": []
}Get activity
Get an activity.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- Intervals.icu response data.
Example output
{
"data": {}
}Get athlete
Get the athlete with sportSettings and custom_items.
Inputs
None.
Outputs
dataobject- Intervals.icu response data.
Example output
{
"data": {
"activity_rpe_prompt": false,
"add_weather_to_strava_descr": false,
"beta_user": false,
"bikes": [],
"bio": "example",
"city": "example",
"coach_ticks": [],
"concept2_sync_activities": false,
"concept2_user_id": "example",
"coros_download_wellness": false,
"coros_last_upload": "example",
"coros_sync_activities": false,
"coros_upload_workouts": false,
"coros_user_id": "example",
"countries": [],
"country": "example",
"currency": "example",
"custom_items": [],
"date_format": "example",
"dropbox_scope": "example",
"email": "example",
"email_notifications": [],
"fahrenheit": false,
"firstname": "example",
"garmin_pace_range": 1.0,
"garmin_power_target": "POWER_LAP",
"garmin_sync_activity_types": [],
"garmin_sync_after": "example",
"google_scope": "example",
"google_wellness_keys": [],
"has_password": false,
"has_push_subscriptions": false,
"height": 1.0,
"height_units": "CM",
"huawei_download_wellness": false,
"huawei_sync_activities": false,
"huawei_upload_workouts": false,
"huawei_user_id": "example",
"icu_activated": "example",
"icu_admin": false,
"icu_coach": false,
"icu_date_of_birth": "example",
"icu_effort_secs": [],
"icu_email_disabled": "example",
"icu_email_verified": false,
"icu_form_as_percent": false,
"icu_garmin_download_wellness": false,
"icu_garmin_health": false,
"icu_garmin_hr_range": 1.0,
"icu_garmin_last_upload": "example",
"icu_garmin_outdoor_power_range": 1.0,
"icu_garmin_sync_activities": false,
"icu_garmin_training": false,
"icu_garmin_upload_filters": [],
"icu_garmin_upload_workouts": false,
"icu_garmin_wellness_keys": [],
"icu_last_seen": "example",
"icu_menstrual_cycle_perm": "NONE",
"icu_mmp_days": 1,
"icu_permission": "NONE",
"icu_queue_pos": 1,
"icu_resting_hr": 1,
"icu_send_achievements": false,
"icu_send_activity_chat": false,
"icu_send_activity_msg": false,
"icu_send_coach_me_req": false,
"icu_send_coach_tick": false,
"icu_send_coached_activity_chat": false,
"icu_send_coached_new_activity": false,
"icu_send_follow_req": false,
"icu_send_followed_activity_chat": false,
"icu_send_followed_new_activity": false,
"icu_send_gear_alerts": false,
"icu_send_group_chat": false,
"icu_send_group_msg": false,
"icu_send_newsletter": false,
"icu_send_plan_for_week": false,
"icu_send_private_chat": false,
"icu_send_private_msg": false,
"icu_track_menstrual_cycle": false,
"icu_type_settings": [],
"icu_weight": 1.0,
"icu_weight_sync": "NONE",
"icu_wellness_keys": [],
"icu_wellness_prompt": false,
"id": "example",
"ignore_strava_gear": false,
"include_descr_in_plan_for_week": false,
"languages": [],
"lastname": "example",
"locale": "example",
"measurement_preference": "example",
"name": "example",
"notification_athlete_tags_enabled": [],
"open_step_duration": 1,
"oura_scope": "example",
"oura_wellness_keys": [],
"plan": "FREE",
"plan_expires": "example",
"polar_download_wellness": false,
"polar_scope": "example",
"polar_sync_activities": false,
"polar_sync_activity_types": [],
"polar_wellness_keys": [],
"private_wellness_keys": [],
"profile_medium": "example",
"push_notifications": [],
"rain": "MM",
"scope": "example",
"sex": "example",
"shoes": [],
"sponsored_by_chat_id": 1,
"sportSettings": [],
"state": "example",
"status": "ACTIVE",
"status_updated": "example",
"strava_allowed": false,
"strava_authorized": false,
"strava_id": 1,
"strava_sync_activities": false,
"strava_sync_activity_types": [],
"strava_sync_other_activities": false,
"suunto_download_wellness": false,
"suunto_hr_range": 1.0,
"suunto_last_upload": "example",
"suunto_outdoor_power_range": 1.0,
"suunto_pace_range": 1.0,
"suunto_scope": "example",
"suunto_sync_activities": false,
"suunto_sync_activity_types": [],
"suunto_upload_filters": [],
"suunto_upload_workouts": false,
"suunto_user_id": "example",
"time_format": "example",
"timezone": "example",
"training_availability": [],
"training_plan_id": 1,
"training_plan_start_date": "example",
"trial_end_date": "example",
"update_strava_name": false,
"visibility": "PRIVATE",
"wahoo_sync_activities": false,
"wahoo_upload_workouts": false,
"wahoo_user_id": "example",
"website": "example",
"weight": 1.0,
"weight_pref_lb": false,
"wellness_last_prompt_date": "example",
"whoop_scope": "example",
"whoop_wellness_keys": [],
"wind_speed": "MPS",
"zepp_download_wellness": false,
"zepp_sync_activities": false,
"zepp_upload_workouts": false,
"zepp_user_id": "example",
"zwift_sync_activities": false,
"zwift_upload_workouts": false,
"zwift_user_id": "example"
}
}Get event
Get an event (planned workout, note etc.).
Inputs
- Event ID
eventIdtextRequired - Event ID.
Outputs
dataobject- Intervals.icu response data.
Example output
{
"data": {
"athlete_cannot_edit": false,
"athlete_id": "example",
"atl_days": 1,
"attachments": [],
"calendar_id": 1,
"can_train_sports": [],
"carbs_per_hour": 1,
"carbs_used": 1,
"category": "WORKOUT",
"color": "example",
"created_by_id": "example",
"ctl_days": 1,
"description": "example",
"distance": 1.0,
"distance_target": 1.0,
"end_date_local": "example",
"entered": false,
"external_id": "example",
"for_week": false,
"hide_from_athlete": false,
"icu_atl": 1.0,
"icu_ctl": 1.0,
"icu_ftp": 1,
"icu_intensity": 1.0,
"icu_training_load": 1,
"id": 1,
"indoor": false,
"joules": 1,
"joules_above_ftp": 1,
"load_target": 1,
"max_training_time": 1,
"moving_time": 1,
"name": "example",
"not_on_fitness_chart": false,
"oauth_client_id": 1,
"p_max": 1,
"plan_applied": "example",
"plan_athlete_id": "example",
"plan_folder_id": 1,
"plan_workout_id": 1,
"push_errors": [],
"shared_event_id": 1,
"show_as_note": false,
"show_on_ctl_line": false,
"ss_cp": 1.0,
"ss_p_max": 1.0,
"ss_w_prime": 1.0,
"start_date_local": "example",
"strain_score": 1.0,
"structure_read_only": false,
"sub_type": "NONE",
"tags": [],
"target": "AUTO",
"time_target": 1,
"training_availability": "NORMAL",
"type": "example",
"uid": "example",
"updated": "example",
"w_prime": 1,
"workout_doc": {}
}
}Get wellness
Get wellness record for date (local ISO-8601 day).
Inputs
- Date
datedateRequired - Date.
Outputs
dataobject- Intervals.icu response data.
Example output
{
"data": {
"abdomen": 1.0,
"atl": 1.0,
"atlLoad": 1.0,
"avgSleepingHR": 1.0,
"baevskySI": 1.0,
"bloodGlucose": 1.0,
"bodyFat": 1.0,
"carbohydrates": 1.0,
"comments": "example",
"ctl": 1.0,
"ctlLoad": 1.0,
"diastolic": 1,
"fatTotal": 1.0,
"fatigue": 1,
"floorsClimbed": 1,
"hrv": 1.0,
"hrvSDNN": 1.0,
"hydration": 1,
"hydrationVolume": 1.0,
"id": "example",
"injury": 1,
"kcalConsumed": 1,
"lactate": 1.0,
"locked": false,
"menstrualPhase": "PERIOD",
"menstrualPhasePredicted": "PERIOD",
"mood": 1,
"motivation": 1,
"protein": 1.0,
"rampRate": 1.0,
"readiness": 1.0,
"respiration": 1.0,
"restingHR": 1,
"sleepQuality": 1,
"sleepScore": 1.0,
"sleepSecs": 1,
"soreness": 1,
"spO2": 1.0,
"sportInfo": [],
"steps": 1,
"stress": 1,
"systolic": 1,
"tempRestingHR": false,
"tempWeight": false,
"updated": "example",
"vo2max": 1.0,
"weight": 1.0
}
}Get workout
Get a workout.
Inputs
- Workout ID
workoutIdtextRequired - Workout ID.
Outputs
dataobject- Intervals.icu response data.
Example output
{
"data": {
"athlete_id": "example",
"attachments": [],
"carbs_per_hour": 1,
"color": "example",
"day": 1,
"days": 1,
"description": "example",
"distance": 1.0,
"folder_id": 1,
"for_week": false,
"hide_from_athlete": false,
"icu_intensity": 1.0,
"icu_training_load": 1,
"id": 1,
"indoor": false,
"joules": 1,
"joules_above_ftp": 1,
"moving_time": 1,
"name": "example",
"plan_applied": "example",
"sub_type": "NONE",
"tags": [],
"target": "AUTO",
"targets": [],
"time": "example",
"type": "example",
"updated": "example",
"workout_doc": {}
}
}List activities
List activities for a date range in desc date order.
Inputs
- Oldest
oldestdateRequired - Local ISO-8601 date or date and time e.g. 2019-07-22T16:18:49 or 2019-07-22
- Newest
newestdate - Local ISO-8601 date or date and time, defaults to now
Outputs
datalist- Intervals.icu response data.
Example output
{
"data": []
}List events
List events (planned workouts, notes etc.) on the athlete's calendar, add .csv for CSV output.
Inputs
- Oldest
oldestdate - Local date (ISO-8601) for oldest event to return, default is today in the athletes timezone
- Newest
newestdate - Local date (ISO-8601) for newest event to return (inclusive), default is oldest plus 6 days
Outputs
datalist- Intervals.icu response data.
Example output
{
"data": []
}List folders
List all the athlete's folders, plans and workouts.
Inputs
None.
Outputs
datalist- Intervals.icu response data.
Example output
{
"data": []
}List gear
List athlete gear (use .csv for CSV format).
Inputs
None.
Outputs
datalist- Intervals.icu response data.
Example output
{
"data": []
}List routes
List routes for an athlete with activity counts.
Inputs
None.
Outputs
datalist- Intervals.icu response data.
Example output
{
"data": []
}List wellness
List wellness records for date range (use .csv for CSV format).
Inputs
- Oldest
oldestdate - Local date of oldest record (ISO-8601)
- Newest
newestdate - Local date of newest record (ISO-8601), inclusive
Outputs
datalist- Intervals.icu response data.
Example output
{
"data": []
}List workouts
List workouts.
Inputs
- Folder
folderIdtextRequired - Folder ID.
Outputs
datalist- Intervals.icu response data.
Example output
{
"data": []
}Update event
Update an event (planned workout, note etc.).
Inputs
- Event ID
eventIdtextRequired - Event ID.
- Name
nametext - Name.
- Description
descriptiontext - Description.
- Color
colortext - Color.
Outputs
dataobject- Intervals.icu response data.
Example output
{
"data": {
"athlete_cannot_edit": false,
"athlete_id": "example",
"atl_days": 1,
"attachments": [],
"calendar_id": 1,
"can_train_sports": [],
"carbs_per_hour": 1,
"carbs_used": 1,
"category": "WORKOUT",
"color": "example",
"created_by_id": "example",
"ctl_days": 1,
"description": "example",
"distance": 1.0,
"distance_target": 1.0,
"end_date_local": "example",
"entered": false,
"external_id": "example",
"for_week": false,
"hide_from_athlete": false,
"icu_atl": 1.0,
"icu_ctl": 1.0,
"icu_ftp": 1,
"icu_intensity": 1.0,
"icu_training_load": 1,
"id": 1,
"indoor": false,
"joules": 1,
"joules_above_ftp": 1,
"load_target": 1,
"max_training_time": 1,
"moving_time": 1,
"name": "example",
"not_on_fitness_chart": false,
"oauth_client_id": 1,
"p_max": 1,
"plan_applied": "example",
"plan_athlete_id": "example",
"plan_folder_id": 1,
"plan_workout_id": 1,
"push_errors": [],
"shared_event_id": 1,
"show_as_note": false,
"show_on_ctl_line": false,
"ss_cp": 1.0,
"ss_p_max": 1.0,
"ss_w_prime": 1.0,
"start_date_local": "example",
"strain_score": 1.0,
"structure_read_only": false,
"sub_type": "NONE",
"tags": [],
"target": "AUTO",
"time_target": 1,
"training_availability": "NORMAL",
"type": "example",
"uid": "example",
"updated": "example",
"w_prime": 1,
"workout_doc": {}
}
}Update wellness
Update the wellness record for the date (ISO-8601).
Inputs
- Date
datedateRequired - Date.
- Weight
weightnumber - Weight.
- Resting hr
restingHRnumber - Resting hr.
- Sleep secs
sleepSecsnumber - Sleep secs.
Outputs
dataobject- Intervals.icu response data.
Example output
{
"data": {
"abdomen": 1.0,
"atl": 1.0,
"atlLoad": 1.0,
"avgSleepingHR": 1.0,
"baevskySI": 1.0,
"bloodGlucose": 1.0,
"bodyFat": 1.0,
"carbohydrates": 1.0,
"comments": "example",
"ctl": 1.0,
"ctlLoad": 1.0,
"diastolic": 1,
"fatTotal": 1.0,
"fatigue": 1,
"floorsClimbed": 1,
"hrv": 1.0,
"hrvSDNN": 1.0,
"hydration": 1,
"hydrationVolume": 1.0,
"id": "example",
"injury": 1,
"kcalConsumed": 1,
"lactate": 1.0,
"locked": false,
"menstrualPhase": "PERIOD",
"menstrualPhasePredicted": "PERIOD",
"mood": 1,
"motivation": 1,
"protein": 1.0,
"rampRate": 1.0,
"readiness": 1.0,
"respiration": 1.0,
"restingHR": 1,
"sleepQuality": 1,
"sleepScore": 1.0,
"sleepSecs": 1,
"soreness": 1,
"spO2": 1.0,
"sportInfo": [],
"steps": 1,
"stress": 1,
"systolic": 1,
"tempRestingHR": false,
"tempWeight": false,
"updated": "example",
"vo2max": 1.0,
"weight": 1.0
}
}