Overview
- GET /athletes/{id}/stats
- PARAMETERS /athletes/{id}/stats
- GET /athletes/{id}/routes
- PARAMETERS /athletes/{id}/routes
- GET /athlete
- GET /athlete/zones
- GET /athlete/activities
- GET /athlete/clubs
- GET /segments/{id}
- PARAMETERS /segments/{id}
- PUT /segments/{id}/starred
- PARAMETERS /segments/{id}/starred
- GET /segments/{id}/leaderboard
- PARAMETERS /segments/{id}/leaderboard
- GET /segments/{id}/all_efforts
- PARAMETERS /segments/{id}/all_efforts
- GET /segments/{id}/streams
- PARAMETERS /segments/{id}/streams
- GET /segments/starred
- GET /segments/explore
- GET /segment_efforts/{id}
- PARAMETERS /segment_efforts/{id}
- GET /segment_efforts/{id}/streams
- PARAMETERS /segment_efforts/{id}/streams
- GET /segment_efforts
- GET /running_races
- GET /running_races/{id}
- PARAMETERS /running_races/{id}
- GET /activities/{id}
- PARAMETERS /activities/{id}
- GET /activities/{id}/laps
- PARAMETERS /activities/{id}/laps
- GET /activities/{id}/zones
- PARAMETERS /activities/{id}/zones
- GET /activities/{id}/comments
- PARAMETERS /activities/{id}/comments
- GET /activities/{id}/kudos
- PARAMETERS /activities/{id}/kudos
- GET /activities/{id}/streams
- PARAMETERS /activities/{id}/streams
- POST /activities
- GET /clubs/{id}
- PARAMETERS /clubs/{id}
- GET /clubs/{id}/members
- PARAMETERS /clubs/{id}/members
- GET /clubs/{id}/admins
- PARAMETERS /clubs/{id}/admins
- GET /clubs/{id}/activities
- PARAMETERS /clubs/{id}/activities
- GET /routes/{id}
- PARAMETERS /routes/{id}
- GET /routes/{id}/export_gpx
- PARAMETERS /routes/{id}/export_gpx
- GET /routes/{id}/export_tcx
- PARAMETERS /routes/{id}/export_tcx
- GET /routes/{id}/streams
- PARAMETERS /routes/{id}/streams
- POST /uploads
- GET /uploads/{uploadId}
- PARAMETERS /uploads/{uploadId}
- GET /gear/{id}
- PARAMETERS /gear/{id}
GET /athletes/{id}/stats
Summary: Get Athlete Stats
Returns the activity stats of an athlete.
OpenAPI snippet URL
PARAMETERS /athletes/{id}/stats
OpenAPI snippet URL
GET /athletes/{id}/routes
Summary: List Athlete Routes
Returns a list of the routes created by the authenticated athlete using their athlete ID. Private routes are filtered out unless requested by a token with read_all scope.
OpenAPI snippet URL
PARAMETERS /athletes/{id}/routes
OpenAPI snippet URL
GET /athlete
Summary: Get Authenticated Athlete
Returns the currently authenticated athlete. Tokens with profile:read_all scope will receive a detailed athlete representation; all others will receive a summary representation.
OpenAPI snippet URL
GET /athlete/zones
Summary: Get Zones
Returns the the authenticated athlete’s heart rate and power zones. Requires profile:read_all.
OpenAPI snippet URL
GET /athlete/activities
Summary: List Athlete Activities
Returns the activities of an athlete for a specific identifier. Requires activity:read. Only Me activities will be filtered out unless requested by a token with activity:read_all.
OpenAPI snippet URL
GET /athlete/clubs
Summary: List Athlete Clubs
Returns a list of the clubs whose membership includes the authenticated athlete.
OpenAPI snippet URL
GET /segments/{id}
Summary: Get Segment
Returns the specified segment. read_all scope required in order to retrieve athlete-specific segment information, or to retrieve private segments.
OpenAPI snippet URL
PARAMETERS /segments/{id}
OpenAPI snippet URL
PUT /segments/{id}/starred
Summary: Star Segment
Stars/Unstars the given segment for the authenticated athlete. Requires profile:write scope.
OpenAPI snippet URL
PARAMETERS /segments/{id}/starred
OpenAPI snippet URL
GET /segments/{id}/leaderboard
Summary: Get Segment Leaderboard
Returns the specified segment leaderboard.
OpenAPI snippet URL
PARAMETERS /segments/{id}/leaderboard
OpenAPI snippet URL
GET /segments/{id}/all_efforts
Summary: List Segment Efforts
Returns a set of the authenticated athlete’s segment efforts for a given segment.
OpenAPI snippet URL
PARAMETERS /segments/{id}/all_efforts
OpenAPI snippet URL
GET /segments/{id}/streams
Summary: Get Segment Streams
Returns the given segment’s streams. Requires read_all scope for private segments.
OpenAPI snippet URL
PARAMETERS /segments/{id}/streams
OpenAPI snippet URL
GET /segments/starred
Summary: List Starred Segments
List of the authenticated athlete’s starred segments. Private segments are filtered out unless requested by a token with read_all scope.
OpenAPI snippet URL
GET /segments/explore
Summary: Explore segments
Returns the top 10 segments matching a specified query.
OpenAPI snippet URL
GET /segment_efforts/{id}
Summary: Get Segment Effort
Returns a segment effort from an activity that is owned by the authenticated athlete.
OpenAPI snippet URL
PARAMETERS /segment_efforts/{id}
OpenAPI snippet URL
GET /segment_efforts/{id}/streams
Summary: Get Segment Effort Streams
Returns a set of streams for a segment effort completed by the authenticated athlete. Requires read_all scope.
OpenAPI snippet URL
PARAMETERS /segment_efforts/{id}/streams
OpenAPI snippet URL
GET /segment_efforts
Summary: List Segment Efforts
Returns a set of the authenticated athletes segment efforts for a given segment. Requires subscription.
OpenAPI snippet URL
GET /running_races
Summary: List Running Races
Returns a list running races based on a set of search criteria.
OpenAPI snippet URL
GET /running_races/{id}
Summary: Get Running Race
Returns a running race for a given identifier.
OpenAPI snippet URL
PARAMETERS /running_races/{id}
OpenAPI snippet URL
GET /activities/{id}
Summary: Get Activity
Returns the given activity that is owned by the authenticated athlete. Requires activity:read for Everyone and Followers activities. Requires activity:read_all for Only Me activities.
OpenAPI snippet URL
PARAMETERS /activities/{id}
OpenAPI snippet URL
GET /activities/{id}/laps
Summary: List Activity Laps
Returns the laps of an activity identified by an identifier. Requires activity:read for Everyone and Followers activities. Requires activity:read_all for Only Me activities.
OpenAPI snippet URL
PARAMETERS /activities/{id}/laps
OpenAPI snippet URL
GET /activities/{id}/zones
Summary: Get Activity Zones
Summit Feature. Returns the zones of a given activity. Requires activity:read for Everyone and Followers activities. Requires activity:read_all for Only Me activities.
OpenAPI snippet URL
PARAMETERS /activities/{id}/zones
OpenAPI snippet URL
GET /activities/{id}/comments
Summary: List Activity Comments
Returns the comments on the given activity. Requires activity:read for Everyone and Followers activities. Requires activity:read_all for Only Me activities.
OpenAPI snippet URL
PARAMETERS /activities/{id}/comments
OpenAPI snippet URL
GET /activities/{id}/kudos
Summary: List Activity Kudoers
Returns the athletes who kudoed an activity identified by an identifier. Requires activity:read for Everyone and Followers activities. Requires activity:read_all for Only Me activities.
OpenAPI snippet URL
PARAMETERS /activities/{id}/kudos
OpenAPI snippet URL
GET /activities/{id}/streams
Summary: Get Activity Streams
Returns the given activity’s streams. Requires activity:read scope. Requires activity:read_all scope for Only Me activities.
OpenAPI snippet URL
PARAMETERS /activities/{id}/streams
OpenAPI snippet URL
POST /activities
Summary: Create an Activity
Creates a manual activity for an athlete, requires activity:write scope.
OpenAPI snippet URL
GET /clubs/{id}
Summary: Get Club
Returns a given club using its identifier.
OpenAPI snippet URL
PARAMETERS /clubs/{id}
OpenAPI snippet URL
GET /clubs/{id}/members
Summary: List Club Members
Returns a list of the athletes who are members of a given club.
OpenAPI snippet URL
PARAMETERS /clubs/{id}/members
OpenAPI snippet URL
GET /clubs/{id}/admins
Summary: List Club Administrators.
Returns a list of the administrators of a given club.
OpenAPI snippet URL
PARAMETERS /clubs/{id}/admins
OpenAPI snippet URL
GET /clubs/{id}/activities
Summary: List Club Activities
Retrieve recent activities from members of a specific club. The authenticated athlete must belong to the requested club in order to hit this endpoint. Pagination is supported. Athlete profile visibility is respected for all activities.
OpenAPI snippet URL
PARAMETERS /clubs/{id}/activities
OpenAPI snippet URL
GET /routes/{id}
Summary: Get Route
Returns a route using its identifier. Requires read_all scope for private routes.
OpenAPI snippet URL
PARAMETERS /routes/{id}
OpenAPI snippet URL
GET /routes/{id}/export_gpx
Summary: Export Route GPX
Returns a GPX file of the route. Requires read_all scope for private routes.
OpenAPI snippet URL
PARAMETERS /routes/{id}/export_gpx
OpenAPI snippet URL
GET /routes/{id}/export_tcx
Summary: Export Route TCX
Returns a TCX file of the route. Requires read_all scope for private routes.
OpenAPI snippet URL
PARAMETERS /routes/{id}/export_tcx
OpenAPI snippet URL
GET /routes/{id}/streams
Summary: Get Route Streams
Returns the given route’s streams. Requires read_all scope for private routes.
OpenAPI snippet URL
PARAMETERS /routes/{id}/streams
OpenAPI snippet URL
POST /uploads
Summary: Upload Activity
Uploads a new data file to create an activity from. Requires activity:write scope.
OpenAPI snippet URL
GET /uploads/{uploadId}
Summary: Get Upload
Returns an upload for a given identifier. Requires activity:write scope.
OpenAPI snippet URL
PARAMETERS /uploads/{uploadId}
OpenAPI snippet URL
GET /gear/{id}
Summary: Get Equipment
Returns an equipment using its identifier.
OpenAPI snippet URL
PARAMETERS /gear/{id}
OpenAPI snippet URL