How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.2.0.

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.2.0
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
SleepStreamResponse
object
2 properties
Sleep
object
The collection of records in this page.
12 properties 10 required
SleepStageSummary
object
Summary of the sleep stages
8 properties 8 required
SleepScore
object
WHOOP's measurements and evaluation of the sleep activity. Only present if the Sleep State is SCORED
6 properties 2 required
PaginatedSleepResponse
object
2 properties
SleepStreamDataPoint
object
7 properties

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
Where this information came from

This is an independent, third-party profile of WHOOP Sleep API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.