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 Cycle API

The Cycle API from WHOOP — 3 operation(s) for cycle.

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

This API exposes 4 JSON Schema definitions.

Tagged areas include Cycle. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, authentication docs, rate-limit docs, and 4 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version 2.0.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.0.1
API Version
2.0.0
Base URL
https://api.prod.whoop.com/developer
Authentication
OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 2

WHOOP Cycle 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.

Cycle 3
GET
/v2/cycle/{cycleId}
Get Cycle
getCycleById 1 param → 200400404401429500
GET
/v2/cycle
List Cycle
getCycleCollection 4 params → 200400401429500
GET
/v2/cycle/{cycleId}/sleep
List Sleep
getSleepForCycle 1 param → 200400404401429500

Schemas 7

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

SleepStageSummary
object
Summary of the sleep stages
8 properties 8 required
Sleep
object
The collection of records in this page.
12 properties 10 required
Cycle
object
The collection of records in this page.
9 properties 7 required
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
SleepScore
object
WHOOP's measurements and evaluation of the sleep activity. Only present if the Sleep State is SCORED
6 properties 2 required
PaginatedCycleResponse
object
2 properties
CycleScore
object
WHOOP's measurements and evaluation of the cycle. Only present if the score state is SCORED
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whoop-co-cycle-api-openapi.yml Raw ↑

Other APIs WHOOP publishes across the network.

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