Group Events

Group Events are optionally recurring events for club members. Only club members can access private club events. The objects are returned in summary or detailed representations.

Summary Representation Attributes

id:	integer
resource_state:	integer indicates level of detail. Possible values: 2 -> ‘summary’, 3 -> ‘detail’
title:	string
description:	string
club_id:	integer DEPRECATED, use `club.id`
club:	object club meta representation
organizing_athlete:	object may be `null` athlete summary representation, may be `null`.
activity_type:	string ie. ride, run, swim, etc.
created_at:	time string
route_id:	integer may be `null` DEPRECATED, use `route.id`
route:	object may be `null` route meta representation, overview of the route with map
start_latlng:	[latitude, longitude] may be `null`
woman_only:	bool
private:	bool `true` if event is for club members only
skill_levels:	integer 1: casual, 2: tempo, 4: hammerfest
terrain:	integer 0: mostly flat, 1: rolling hills, 2: killer climbs
upcoming_occurrences:	array up to 5 time string values in the UTC timezone
zone:	string event timezone
address:	string may be `null`
joined:	bool whether the authenticated athlete has joined the next occurrence of the event

Detail Representation Attributes

id:	integer
resource_state:	integer indicates level of detail. Possible values: 2 -> ‘summary’, 3 -> ‘detail’
title:	string
description:	string
club_id:	integer DEPRECATED, use `club.id`
club:	object club summary representation
organizing_athlete:	object may be `null` athlete summary representation, may be `null`.
activity_type:	string ie. ride, run, swim, etc.
created_at:	time string
route_id:	integer may be `null` DEPRECATED, use `route.id`
route:	object may be `null` route meta representation, overview of the route with map
start_latlng:	[latitude, longitude] may be `null`
woman_only:	bool
private:	bool `true` if event is for club members only
skill_levels:	integer 1: casual/beginner, 2: tempo/intermediate, 4: race pace/advanced
terrain:	integer 0: mostly flat/road, 1: rolling hills/trail, 2: killer climbs/mixed
upcoming_occurrences:	array up to 5 time string values in the UTC timezone
zone:	string event timezone
address:	string may be `null`
joined:	bool whether the authenticated athlete has joined the next occurrence of the event
viewer_permissions:	object viewer permissions
start_datetime:	string Start date and time in event local timezone. Format: `yyyy-mm-ddThh:mm`, ie. 2017-03-02T18:30
frequency:	string `no_repeat`, `weekly`, `monthly`
day_of_week:	string monthly frequency only `monday`, `tuesday`, etc.
week_of_month:	integer monthly frequency only -1, 1, 2, 3, 4 representing last, 1st, 2nd, 3rd, and 4th `day_of_week` of the month
days_of_week:	array of strings weekly frequency only array of `day_of_week` strings
weekly_interval:	integer weekly frequency only recurring every x week(s), 1-4

Viewer Permissions

edit:

bool
whether the authenticated athlete has permission to edit the event

Example group event

{
  "id": 1234567,
  "resource_state": 3,
  "title": "Test Group Event",
  "description": "Very fun group ride",
  "club": {
    "id": 1,
    "resource_state": 2,
    "name": "Team Strava Cycling",
    "profile_medium": "http://pics.com/clubs/1/medium.jpg",
    "profile": "http://pics.com/clubs/1/large.jpg",
    "cover_photo": "http://pics.com/clubs/1/cover/large.jpg",
    "cover_photo_small": "http://pics.com/clubs/1/cover/small.jpg",
    "sport_type": "cycling",
    "city": "San Francisco",
    "state": "California",
    "country": "United States",
    "private": true,
    "member_count": 23,
    "featured": false,
    "verified": false,
    "url": "strava-cycling"
  },
  "organizing_athlete": {
    "id": 227615,
    "resource_state": 2,
    "firstname": "John",
    "lastname": "Applestrava",
    "profile_medium": "http://pics.com/227615/medium.jpg",
    "profile": "http://pics.com/227615/large.jpg",
    "city": "San Francisco",
    "state": "California",
    "country": "United States",
    "sex": "M",
    "friend": "accepted",
    "follower": "accepted",
    "premium": true,
    "created_at": "2009-08-26T13:42:05Z",
    "updated_at": "2013-01-11T18:51:00Z"
  },
  "activity_type": "Ride",
  "created_at": "2009-08-26T13:42:05Z",
  "route": {
    "id": 123456,
    "resource_state": 1,
    "name": "My awesome route",
    "map": {
      "id": "r123456",
      "summary_polyline": "qareFxi",
      "resource_state": 2
    }
  },
  "start_latlng": [
    37.8,
    -122.27
  ],
  "women_only": false,
  "private": true,
  "skill_levels": 1,
  "terrain": 0,
  "upcoming_occurrences": [
    "2015-04-19T18:48:00Z",
    "2015-04-20T18:48:00Z",
    "2015-04-21T18:48:00Z",
    "2015-04-22T18:48:00Z",
    "2015-04-23T18:48:00Z"
  ],
  "zone:": "America/Los_Angeles",
  "address": "1 Happening St. Reno, NV",
  "joined": true,
  "viewer_permissions": {
    "edit": false
  },
  "start_datetime": "2015-04-19T10:48",
  "frequency": "weekly",
  "days_of_week": [
    "sunday",
    "monday",
    "tuesday",
    "wednesday",
    "thursday"
  ],
  "weekly_interval": 1
}

Retrieve group event

Returns a single group event summary representation.

Parameters

id:	integer required

Definition

GET https://www.strava.com/api/v3/group_events/:id

Example request

$ curl -G https://www.strava.com/api/v3/group_events/123 \
    -H "Authorization: Bearer 83ebeabdec09f6670863766f792ead24d61fe3f9"

List club group events

Returns an array of club group event summary representations ordered by occurrence time.

Parameters

club_id:	integer required
upcoming:	bool optional only include future events if `true`

Definition

GET https://www.strava.com/api/v3/clubs/:club_id/group_events

Example request

$ curl -G https://www.strava.com/api/v3/clubs/1/group_events \
    -H "Authorization: Bearer 83ebeabdec09f6670863766f792ead24d61fe3f9"

Example responses

[
  {
    "id": 1234567,
    "resource_state": 2,
    "title": "Test Group Event",
    "description": "Very fun group ride",
    "club": {
      "id:": 1,
      "resource_state": 1
    },
    "organizing_athlete": {
      "id": 227615,
      "resource_state": 2,
      "firstname": "John",
      "lastname": "Applestrava",
      "profile_medium": "http://pics.com/227615/medium.jpg",
      "profile": "http://pics.com/227615/large.jpg",
      "city": "San Francisco",
      "state": "California",
      "country": "United States",
      "sex": "M",
      "friend": "accepted",
      "follower": "accepted",
      "premium": true,
      "created_at": "2009-08-26T13:42:05Z",
      "updated_at": "2013-01-11T18:51:00Z"
    },
    "activity_type": "Ride",
    "created_at": "2009-08-26T13:42:05Z",
    "route_id": 123456,
    "women_only": false,
    "private": true,
    "skill_levels": 1,
    "terrain": 0,
    "upcoming_occurrences": [
      "2015-04-19T18:47:59Z",
      "2015-04-20T18:47:59Z",
      "2015-04-21T18:47:59Z",
      "2015-04-22T18:47:59Z",
      "2015-04-23T18:47:59Z"
    ],
    "zone:": "America/Los_Angeles",
    "address": "1 Happening St. Reno, NV"
  }
]

Join a group event

Join a group event on behalf of the authenticated athlete. For recurring events, join the upcoming occurrence. An access token with write permissions is required.

Parameters

id:	integer required

Definition

POST https://www.strava.com/api/v3/group_events/:id/rsvps

Example request

$ curl -X POST https://www.strava.com/api/v3/group_events/123/rsvps \
    -H "Authorization: Bearer 83ebeabdec09f6670863766f792ead24d61fe3f9"

Example responses

{
  "joined": true
}

Leave a group event

Leave a group event on behalf of the authenticated athlete. For recurring events, leave the upcoming occurrence. An access token with write permissions is required.

Parameters

id:	integer required

Definition

DELETE https://www.strava.com/api/v3/group_events/:id/rsvps

Example request

$ curl -X DELETE https://www.strava.com/api/v3/group_events/123/rsvps \
    -H "Authorization: Bearer 83ebeabdec09f6670863766f792ead24d61fe3f9"

Example responses

{
  "joined": false
}

Delete a group event

Deletes (and cancels) an event, which must be editable by the authenticating user. An access token with write permissions is required.

Parameters

id:	integer required group event id

Definition

DELETE https://www.strava.com/api/v3/group_events/:id

Example request

$ curl -X DELETE https://www.strava.com/api/v3/group_events/2379 \
    -H "Authorization: Bearer 83ebeabdec09f6670863766f792ead24d61fe3f9"

List joined athletes

Retrieve summary information about athletes joined a specific group event, or the upcoming occurrence for recurring events. Pagination is supported.

Parameters

id:	integer required group event id
page:	integer optional
per_page:	integer optional

Returns an array of athletes summary representations with athletes followed by the authenticated athlete first.

Definition

GET https://www.strava.com/api/v3/group_events/:id/athletes

Example request

$ curl -G https://www.strava.com/api/v3/group_events/123/athletes \
    -H "Authorization: Bearer 83ebeabdec09f6670863766f792ead24d61fe3f9"