OpenWorkout version v1
http://openworkout.cloud/api/{version}
- version: required(v1)
/update_status
Used by the mobile application to update it's status.
/activity_track
Returns the activity track as a collection of JSON objects.
/activity_metadata
Returns the activity metadata as a collection of JSON objects.
/activity_sensordata
Returns the activity sensordata as a collection of JSON objects. Sensor names are specified as a comma-separated list.
/activity_summarydata
Returns data computed from the activity. Summmary items are specified as a comma-separated list.
/update_activity_metadata
/create_login
Creates a new account.
/login_status
Determines if the current user has a valid session token.
/update_email
Updates the user's email address.
/update_password
Updates the user's password.
/delete_users_gear
Removes the current user's gear (all of it).
/delete_users_activities
Removes the current user's activity data (all of it).
/delete_user
Removes the current user and all associated data.
/list_devices
Returns a list of JSON objects describing all of the devices claimed by the logged in user.
/list_all_activities
Returns a list of JSON objects describing all of the user's activities and the activities of the user's friends.
/list_my_activities
Returns a list of JSON objects describing all of the user's activities.
/delete_activity
Removes the specified activity.
/add_activity
Used when manually creating an activity, such as when logging strength training activities.
/upload_activity_file
Creates a new activity from data contained with the appended file.
/upload_activity_photo
Uploads a photo and associates it with an activity.
/list_activity_photos
Lists all photos associated with an activity.
/delete_activity_photo
Deletes a photo and removes it from an activity.
/create_tags_on_activity
Sets the tags on an activity. Tags are provided in a dictionary {"tag0", "foo"|, {"tag1", "bar"), etc.
/delete_tag_from_activity
Deletes a tag from an activity.
/delete_sensor_data
Deletes the specified set of sensor data (power, cadence, heart rate, etc.) from an activity.
/list_matched_users
Lists user's whose usernames match the search criteria. Results are limited to the first 100 users.
/list_pending_friends
Lists the users who are requesting friendship with the logged in user.
/list_friends
Lists the users who are friends with the logged in user.
/request_to_be_friends
Sends a request to friend another user.
/confirm_request_to_be_friends
Takes a user to the pending friends list and adds them to the actual friends list.
/unfriend
/trim_activity
/export_activity
Returns the activity in the specified format.
/export_workout
Returns the workout in the specified format.
/claim_device
Associates the device specified by the unique identifier with the logged in user's account.
/list_tags
Lists the tags for the specified activity.
/create_comment
Adds a comment to the specified activity.
/list_comments
Lists comments for the specified activity.
/create_gear
Creates a new gear record for the current user, such as a new bike or pair of shoes.
/list_gear
Lists gear associated with the current user.
/list_gear_defaults
Lists the gear that is, by default, associated with each activity type.
/update_gear
Updates the gear name or description.
/update_gear_defaults
Updates the gear a user wants to associate with an activity type, by default, is received.
/delete_gear
Delete's the specified gear record and all associated service records.
/retire_gear
Marks the specified gear as retired.
/create_service_record
Appends service information for a piece of gear (intended for tracking bicycle service data).
/delete_service_record
Deletes service informatio for a piece of gear.
/create_race
Creates a race (workout goal) on a user's profile.
/create_race
Adds a race to the calendar.
/delete_race
Removes a race (workout goal) on a user's profile.
/update_settings
/update_profile
/update_visibility
Updates activity visibility.
/refresh_analysis
Schedules the specified activity for (re)analysis.
/refresh_personal_records
Refreshes the cache of personal records in the event it may have become corrupted by deleting activities, or changing activity types.
/generate_workout_plan
Schedules workout plan generation. Will generate workouts for the week.
/list_planned_workouts
Lists planned/scheduled workouts.
/update_planned_workouts
Replace all of a user's planned/scheduled workouts.
/delete_planned_workout
Deletes a specified planned/scheduled workout.
/delete_planned_workouts
Deletes all of a user's planned/scheduled workouts.
/list_interval_workouts
Lists interval workouts.
/create_pace_plan
Creates a pace plan.
/list_pace_plans
Lists pace plans.
/delete_pace_plan
Deletes the specified pace plan.
/get_workout_ical_url
Returns a link to the ical url for their planned workouts.
/get_location_description
Returns the political location that corresponds to an activity.
/get_location_summary
Returns the summary of all political locations in which activities have occurred. Result is a JSON string.
/activity_hash_from_id
Given the activity hash, return sthe activity ID, or an error if not found. Only looks at the logged in user's activities.
/has_activity
Given the activity ID has hash, returns whether or not the activity exists in the database for the logged in user.
/list_personal_records
Returns the user's personal records. Result is a JSON string.
/get_running_paces
Returns the user's estimated running paces. Result is a JSON string.
/get_distance_for_tag
Returns the amount of distance logged to activities with the given tag. Result is a JSON string.
/get_task_statuses
Returns a description of all deferred tasks for the logged in user. Result is a JSON string.
/get_record_progression
Returns an ordered list containing the time and activity ID of the user's record progression for the specified record and activity type, i.e. best running 5K. Result is a JSON string.
/get_user_setting
Returns the value associated with the specified user setting.
/get_user_settings
Returns a JSON list of values associated with the specified user settings. Input is a comma-separated list.
/estimate_vo2_max
Returns the user's estimated VO2 max.
/estimate_bmi
Returns the user's estimated BMI.
/list_power_zones
/list_hr_zones
/generate_api_key
Generates a new API key for the logged in user.
/delete_api_key
Deletes the specified API key.
/list_api_keys
Returns the API keys associated witht he logged in user.
/list_activity_types
Returns the list of all activity types the software understands.
/list_workout_types_for_activity
Returns a the list of workout types that that correspond with the given activity type (i.e. running has easy runs, tempo runs, etc.).
/list_unsynched_activities
Returns any changes since the last time the device was synched.