cURL
curl --request GET \ --url https://api.example.com/api/v1/users/{user_id}/events/sleep \ --header 'Authorization: Bearer <token>'
{ "data": [ { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "start_time": "2023-11-07T05:31:56Z", "end_time": "2023-11-07T05:31:56Z", "source": { "provider": "apple_health", "device": "Apple Watch Series 9" }, "duration_seconds": 123, "zone_offset": "<string>", "efficiency_percent": 123, "stages": { "awake_minutes": 123, "light_minutes": 123, "deep_minutes": 123, "rem_minutes": 123 }, "sleep_stage_intervals": [ { "stage": "in_bed", "start_time": "2023-11-07T05:31:56Z", "end_time": "2023-11-07T05:31:56Z" } ], "is_nap": false } ], "pagination": { "has_more": true, "next_cursor": "eyJpZCI6IjEyMzQ1Njc4OTAiLCJ0cyI6MTcwNDA2NzIwMH0", "previous_cursor": "<string>", "total_count": 150 }, "metadata": { "resolution": "raw", "sample_count": 123, "start_time": "2023-11-07T05:31:56Z", "end_time": "2023-11-07T05:31:56Z" } }
Returns sleep sessions (including naps).
The access token received from the authorization server in the OAuth 2.0 flow.
1 <= x <= 100
Successful Response
Show child attributes
Was this page helpful?