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 |
| getclubby_id | GET /clubs/{id} | Get Club |
| getclubmembersbyid | GET /clubs/{id}/members | List Club Members |
| getloggedinathleteclubs | GET /athlete/clubs | List Athlete Clubs |
getclubactivitiesbyid
get_club_activities_by_id(api::ClubsApi,id::Int64;page=nothing, `perpage=nothing, _mediaType=nothing) ->Vector{ClubActivity},OpenAPI.Clients.ApiResponse<br/>getclubactivitiesbyid(_api::ClubsApi, response_stream::Channel,id::Int64;page=nothing,per_page=nothing, _mediaType=nothing) ->Channel{Vector{ClubActivity}},OpenAPI.Clients.ApiResponse`
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 |
|---|---|---|---|
| _api | ClubsApi | API context | |
id | Int64 | The identifier of the club. |
Optional Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
page | Int64 | Page number. Defaults to 1. | [default to nothing] |
per_page | Int64 | Number of items per page. Defaults to 30. | [default to 30] |
Return type
Authorization
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
get_club_admins_by_id(api::ClubsApi,id::Int64;page=nothing, `perpage=nothing, _mediaType=nothing) ->Vector{SummaryAthlete},OpenAPI.Clients.ApiResponse<br/>getclubadminsbyid(_api::ClubsApi, response_stream::Channel,id::Int64;page=nothing,per_page=nothing, _mediaType=nothing) ->Channel{Vector{SummaryAthlete}},OpenAPI.Clients.ApiResponse`
List Club Administrators
Returns a list of the administrators of a given club.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | ClubsApi | API context | |
id | Int64 | The identifier of the club. |
Optional Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
page | Int64 | Page number. Defaults to 1. | [default to nothing] |
per_page | Int64 | Number of items per page. Defaults to 30. | [default to 30] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getclubby_id
get_club_by_id(api::ClubsApi,id::Int64; _mediaType=nothing) ->DetailedClub,OpenAPI.Clients.ApiResponse<br/> `getclubbyid(_api::ClubsApi, response_stream::Channel,id::Int64; _mediaType=nothing) ->Channel{DetailedClub},OpenAPI.Clients.ApiResponse`
Get Club
Returns a given a club using its identifier.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | ClubsApi | API context | |
id | Int64 | The identifier of the club. |
Return type
Authorization
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
get_club_members_by_id(api::ClubsApi,id::Int64;page=nothing, `perpage=nothing, _mediaType=nothing) ->Vector{ClubAthlete},OpenAPI.Clients.ApiResponse<br/>getclubmembersbyid(_api::ClubsApi, response_stream::Channel,id::Int64;page=nothing,per_page=nothing, _mediaType=nothing) ->Channel{Vector{ClubAthlete}},OpenAPI.Clients.ApiResponse`
List Club Members
Returns a list of the athletes who are members of a given club.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | ClubsApi | API context | |
id | Int64 | The identifier of the club. |
Optional Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
page | Int64 | Page number. Defaults to 1. | [default to nothing] |
per_page | Int64 | Number of items per page. Defaults to 30. | [default to 30] |
Return type
Authorization
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
get_logged_in_athlete_clubs(api::ClubsApi;page=nothing, `perpage=nothing, _mediaType=nothing) ->Vector{SummaryClub},OpenAPI.Clients.ApiResponse<br/>getloggedinathleteclubs(_api::ClubsApi, response_stream::Channel;page=nothing,per_page=nothing, _mediaType=nothing) ->Channel{Vector{SummaryClub}},OpenAPI.Clients.ApiResponse`
List Athlete Clubs
Returns a list of the clubs whose membership includes the authenticated athlete.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | ClubsApi | API context |
Optional Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
page | Int64 | Page number. Defaults to 1. | [default to nothing] |
per_page | Int64 | Number of items per page. Defaults to 30. | [default to 30] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]