API reference
Workouts

Retrieve user workouts
GET
Request
Response
Query Parameters
from
String
required
The start date of the query based on the user timezone; inclusive
provider
String
optional
Allowed values:health_connect; fitbit; garmin; huawei; whoop; suunto; apple; oura; polar
timezone
String
optional
The timezone to use for responses, it would convert the internal timestamp from UTC to this timezone; if you leave empty it would use the user's timezone
Example: America/New_York
to
String
required
The end date of the query based on the user timezone; non-inclusive
Header Parameters
Authorization
String
required
Provide your bearer token in the Authorization header when making requests to protected resources.
Curl
curl --request GET \
  --url https://app-api.spikeapi.com/v3/queries/workouts \
  --header 'Accept: application/json, application/problem+json' \
  --header 'Authorization: Bearer 123'
curl --request GET \
  --url https://app-api.spikeapi.com/v3/queries/workouts \
  --header 'Accept: application/json, application/problem+json' \
  --header 'Authorization: Bearer 123'
Responses
200
{
            "record_id": "0134fece-6679-83a0-bf53-b509a3a93a70",
            "modified_at": "2025-03-18T06:03:38Z",
            "start_at_timestamp": "2025-03-18T05:27:46Z",
            "end_at_timestamp": "2025-03-18T06:03:38Z",
            "duration": 2152000,
            "user_time_offset_minutes": 120,
            "input_method": "device",
            "metrics": {
                "heartrate_max": 170,
                "heartrate_avg": 139,
                "heartrate_min": 83,
                "calories_burned_active": 357.0000,
                "distance": 1625.0000,
                "speed_max": 1.4080,
                "speed_avg": 0.7550,
                "duration_active": 2152,
                "cadence_avg": 24.0000,
                "pace_avg": 22.08
            },
            "provider_source": "garmin_wellness_activity_details",
            "provider_source_type": "activity",
            "provider_slug": "garmin",
            "source": {
                "device_manufacturer": "Garmin",
                "device_product": "Venu Sq"
            },
            "workout_id": "49ba509e-2bef-55e1-9323-64835b6fd538",
            "workout_type": "swimming",
            "workout_tags": [
                "swimming",
                "workout"
            ],
            "laps": [
                {
                    "start_at": "2025-03-18T05:27:46Z",
                    "end_at": "2025-03-18T05:38:09Z",
                    "duration": 623000,
                    "lap": 1,
                    "samples": {}
                },
                {
                    "start_at": "2025-03-18T05:38:09Z",
                    "end_at": "2025-03-18T05:45:53Z",
                    "duration": 464000,
                    "lap": 2,
                    "samples": {}
                },
                {
                    "start_at": "2025-03-18T05:45:53Z",
                    "end_at": "2025-03-18T05:53:34Z",
                    "duration": 461000,
                    "lap": 3,
                    "samples": {}
                },
                {
                    "start_at": "2025-03-18T05:53:34Z",
                    "end_at": "2025-03-18T06:01:11Z",
                    "duration": 457000,
                    "lap": 4,
                    "samples": {}
                },
                {
                    "start_at": "2025-03-18T06:01:11Z",
                    "end_at": "2025-03-18T06:03:38Z",
                    "duration": 147000,
                    "lap": 5,
                    "samples": {}
                }
            ],
            "samples": [
                {
                    "start_at": "2025-03-18T05:27:46Z",
                    "end_at": "2025-03-18T05:27:46Z",
                    "metrics": {
                        "heartrate_max": 170,
                        "heartrate_avg": 139,
                        "heartrate_min": 83
                    }
                }
            ]
        },
{
            "record_id": "0134fece-6679-83a0-bf53-b509a3a93a70",
            "modified_at": "2025-03-18T06:03:38Z",
            "start_at_timestamp": "2025-03-18T05:27:46Z",
            "end_at_timestamp": "2025-03-18T06:03:38Z",
            "duration": 2152000,
            "user_time_offset_minutes": 120,
            "input_method": "device",
            "metrics": {
                "heartrate_max": 170,
                "heartrate_avg": 139,
                "heartrate_min": 83,
                "calories_burned_active": 357.0000,
                "distance": 1625.0000,
                "speed_max": 1.4080,
                "speed_avg": 0.7550,
                "duration_active": 2152,
                "cadence_avg": 24.0000,
                "pace_avg": 22.08
            },
            "provider_source": "garmin_wellness_activity_details",
            "provider_source_type": "activity",
            "provider_slug": "garmin",
            "source": {
                "device_manufacturer": "Garmin",
                "device_product": "Venu Sq"
            },
            "workout_id": "49ba509e-2bef-55e1-9323-64835b6fd538",
            "workout_type": "swimming",
            "workout_tags": [
                "swimming",
                "workout"
            ],
            "laps": [
                {
                    "start_at": "2025-03-18T05:27:46Z",
                    "end_at": "2025-03-18T05:38:09Z",
                    "duration": 623000,
                    "lap": 1,
                    "samples": {}
                },
                {
                    "start_at": "2025-03-18T05:38:09Z",
                    "end_at": "2025-03-18T05:45:53Z",
                    "duration": 464000,
                    "lap": 2,
                    "samples": {}
                },
                {
                    "start_at": "2025-03-18T05:45:53Z",
                    "end_at": "2025-03-18T05:53:34Z",
                    "duration": 461000,
                    "lap": 3,
                    "samples": {}
                },
                {
                    "start_at": "2025-03-18T05:53:34Z",
                    "end_at": "2025-03-18T06:01:11Z",
                    "duration": 457000,
                    "lap": 4,
                    "samples": {}
                },
                {
                    "start_at": "2025-03-18T06:01:11Z",
                    "end_at": "2025-03-18T06:03:38Z",
                    "duration": 147000,
                    "lap": 5,
                    "samples": {}
                }
            ],
            "samples": [
                {
                    "start_at": "2025-03-18T05:27:46Z",
                    "end_at": "2025-03-18T05:27:46Z",
                    "metrics": {
                        "heartrate_max": 170,
                        "heartrate_avg": 139,
                        "heartrate_min": 83
                    }
                }
            ]
        },
﻿
﻿
Provider records by ID
Workouts record by ID