Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WHOOP Sleep API

The Sleep API from WHOOP — 3 operation(s) for sleep.

WHOOP Sleep API is one of 7 APIs that WHOOP publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sleep. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a getting-started guide.

This API exposes 3 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1.

Requests are made against a single base URL, https://api.prod.whoop.com/developer.

3 operations 3 paths 7 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
Base URL
https://api.prod.whoop.com
Authentication
OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 2

WHOOP Sleep API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth) using the authorizationCode flow, exposing 6 scopes. It supports OAuth 2.0 (Trusted Partner) using the clientCredentials flow, exposing 1 scope.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Sleep 3
GET
/v2/activity/sleep/{sleepId}
Get the sleep for the specified ID
getSleepById 1 param → 200400404401429500
GET
/v2/activity/sleep
Get all sleeps for a user, paginated. Results are sorted by start time in descending order.
getSleepCollection 4 params → 200400401429500
GET
/v2/activity/sleep/{sleepId}/stream
Get the raw signal stream for the specified sleep ID.
getSleepStream 2 params → 200400401403404429500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Sleep (12 properties), SleepStageSummary (8 properties), SleepStreamDataPoint (7 properties), SleepScore (6 properties). Each schema is shown below with its type and property counts.

SleepNeeded
object
Breakdown of the amount of sleep a user needed before the sleep activity. Summing all individual components results in the amount of sleep the user needed prio…
4 properties 4 required
SleepStageSummary
object
Summary of the sleep stages
8 properties 8 required
SleepStreamResponse
object
2 properties
SleepStreamDataPoint
object
7 properties
PaginatedSleepResponse
object
2 properties
Sleep
object
The collection of records in this page.
12 properties 10 required
SleepScore
object
WHOOP's measurements and evaluation of the sleep activity. Only present if the Sleep State is SCORED
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whoop-sleep-api-openapi.yml Raw ↑

Other APIs WHOOP publishes across the network.

WHOOP Activity ID Mapping API
WHOOP Cycle API
WHOOP Partner API
WHOOP Recovery API
WHOOP User API
WHOOP Workout API