Skip to content

Latest commit

 

History

History
191 lines (121 loc) · 6.61 KB

ClubsApi.md

File metadata and controls

191 lines (121 loc) · 6.61 KB
Raw

\ClubsApi

All URIs are relative to https://www.strava.com/api/v3

Method HTTP request Description
GetClubActivitiesById Get /clubs/{id}/activities List Club Activities
GetClubAdminsById Get /clubs/{id}/admins List Club Administrators.
GetClubById Get /clubs/{id} Get Club
GetClubMembersById Get /clubs/{id}/members List Club Members
GetLoggedInAthleteClubs Get /athlete/clubs List Athlete Clubs

GetClubActivitiesById

[]SummaryActivity GetClubActivitiesById(ctx, id, optional) 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.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 The identifier of the club.
optional *GetClubActivitiesByIdOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetClubActivitiesByIdOpts struct

Name Type Description Notes

page | optional.Int32| Page number. | perPage | optional.Int32| Number of items per page. Defaults to 30. | [default to 30]

Return type

[]SummaryActivity

Authorization

strava_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetClubAdminsById

[]SummaryAthlete GetClubAdminsById(ctx, id, optional) List Club Administrators.

Returns a list of the administrators of a given club.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 The identifier of the club.
optional *GetClubAdminsByIdOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetClubAdminsByIdOpts struct

Name Type Description Notes

page | optional.Int32| Page number. | perPage | optional.Int32| Number of items per page. Defaults to 30. | [default to 30]

Return type

[]SummaryAthlete

Authorization

strava_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetClubById

DetailedClub GetClubById(ctx, id) Get Club

Returns a given club using its identifier.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 The identifier of the club.

Return type

DetailedClub

Authorization

strava_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetClubMembersById

[]SummaryAthlete GetClubMembersById(ctx, id, optional) List Club Members

Returns a list of the athletes who are members of a given club.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 The identifier of the club.
optional *GetClubMembersByIdOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetClubMembersByIdOpts struct

Name Type Description Notes

page | optional.Int32| Page number. | perPage | optional.Int32| Number of items per page. Defaults to 30. | [default to 30]

Return type

[]SummaryAthlete

Authorization

strava_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLoggedInAthleteClubs

[]SummaryClub GetLoggedInAthleteClubs(ctx, optional) List Athlete Clubs

Returns a list of the clubs whose membership includes the authenticated athlete.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetLoggedInAthleteClubsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetLoggedInAthleteClubsOpts struct

Name Type Description Notes
page optional.Int32 Page number.
perPage optional.Int32 Number of items per page. Defaults to 30. [default to 30]

Return type

[]SummaryClub

Authorization

strava_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]