GET v1/Events?account_token={account_token}&languageCode={languageCode}

Gets a summary of all events for a given account

Request Information

URI Parameters

Name	Description	Type	Additional information
account_token	The token used to identify the Peloton account	string	Required
languageCode	The language code for the event data	string	Default value is en
version		string	None.

Body Parameters

None.

Response Information

Resource Description

event_list_response

Name	Description	Type	Additional information
events	A list of events	Collection of event_summary	None.
success	True if successful, false otherwise	boolean	None.
message	The message related to the operation in the language specified by the request	string	None.
message_code	The code associated with the message	integer	None.
errors	List of validation errors that occured, otherwise empty	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "events": [
    {
      "event_token": "sample string 1",
      "name": "sample string 2",
      "description": "sample string 3",
      "start_datetime": "2021-04-10T14:18:42.4687941-07:00",
      "end_datetime": "2021-04-10T14:18:42.4687941-07:00",
      "friendly_url_path": "sample string 6",
      "state": {
        "name": "sample string 1",
        "code": "sample string 2"
      }
    },
    {
      "event_token": "sample string 1",
      "name": "sample string 2",
      "description": "sample string 3",
      "start_datetime": "2021-04-10T14:18:42.4687941-07:00",
      "end_datetime": "2021-04-10T14:18:42.4687941-07:00",
      "friendly_url_path": "sample string 6",
      "state": {
        "name": "sample string 1",
        "code": "sample string 2"
      }
    }
  ],
  "success": true,
  "message": "sample string 2",
  "message_code": 3,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}