> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/whoop.md).

# WHOOP

Connect to WHOOP to read recovery, sleep, workout, and cycle data from your wearable device.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| WHOOP     | OAuth sign-in  |

### WHOOP

Connect to WHOOP to read recovery, sleep, workout, and cycle data from your wearable device.

#### Set up in WHOOP

1. Use a WHOOP account with access to the records and operations that your workflow needs.
2. If your organization restricts application access or user consent, have its administrator approve the connection before you sign in.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **WHOOP**.
2. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

StackAI obtains the OAuth credentials during sign-in. You do not need to paste an access token or refresh token.

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **WHOOP** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Get Recovery Scores

Pull your recovery scores over a date range. Each recovery tells you how ready your body is for strain, with your recovery percentage, resting heart rate, and heart-rate variability (HRV). Leave the dates empty to get your most recent recoveries.

**Required permissions:** `read:recovery`.

#### Inputs

| Field           | Type     | Required | Description                                                                                                   |
| --------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Start date      | datetime | No       | Only include recoveries on or after this date and time. Leave empty to include your oldest data.              |
| End date        | datetime | No       | Only include recoveries up to this date and time. Leave empty to include everything up to now.                |
| Maximum results | integer  | No       | How many recoveries to return at most. Newest recoveries come first. Default: 25.                             |
| Page cursor     | string   | No       | Continue from where a previous run left off. Paste the token returned by the last run to fetch the next page. |

#### Outputs

| Field            | Type          | Description                                                |
| ---------------- | ------------- | ---------------------------------------------------------- |
| Recoveries       | object\_array | The list of recovery records in the window.                |
| Next page cursor | string        | Token to fetch the next page of recoveries, if any remain. |

### Get Sleep Activities

Pull your sleep sessions over a date range. Each session includes whether it was a nap, sleep performance, and sleep efficiency. Leave the dates empty to get your most recent sleeps.

**Required permissions:** `read:sleep`.

#### Inputs

| Field           | Type     | Required | Description                                                                                            |
| --------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------ |
| Start date      | datetime | No       | Only include sleeps on or after this date and time. Leave empty to include your oldest data.           |
| End date        | datetime | No       | Only include sleeps up to this date and time. Leave empty to include everything up to now.             |
| Maximum results | integer  | No       | How many sleep sessions to return at most. Newest come first. Default: 25.                             |
| Page cursor     | string   | No       | Continue from where a previous run left off. Paste the token from the last run to fetch the next page. |

#### Outputs

| Field            | Type          | Description                                            |
| ---------------- | ------------- | ------------------------------------------------------ |
| Sleep sessions   | object\_array | The list of sleep sessions in the window.              |
| Next page cursor | string        | Token to fetch the next page of sleeps, if any remain. |

### Get Workouts

Pull your workouts over a date range. Each workout includes the sport, cardiovascular strain, average and max heart rate, and energy expended (in kilojoules). Leave the dates empty to get your most recent workouts.

**Required permissions:** `read:workout`.

#### Inputs

| Field           | Type     | Required | Description                                                                                            |
| --------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------ |
| Start date      | datetime | No       | Only include workouts on or after this date and time. Leave empty to include your oldest data.         |
| End date        | datetime | No       | Only include workouts up to this date and time. Leave empty to include everything up to now.           |
| Maximum results | integer  | No       | How many workouts to return at most. Newest come first. Default: 25.                                   |
| Page cursor     | string   | No       | Continue from where a previous run left off. Paste the token from the last run to fetch the next page. |

#### Outputs

| Field            | Type          | Description                                              |
| ---------------- | ------------- | -------------------------------------------------------- |
| Workouts         | object\_array | The list of workouts in the window.                      |
| Next page cursor | string        | Token to fetch the next page of workouts, if any remain. |

### Get Daily Cycles

Pull your physiological cycles (WHOOP's version of a day) over a date range. Each cycle includes your day strain, average and max heart rate, and calories burned. Leave the dates empty to get your most recent cycles.

**Required permissions:** `read:cycles`.

#### Inputs

| Field           | Type     | Required | Description                                                                                            |
| --------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------ |
| Start date      | datetime | No       | Only include cycles on or after this date and time. Leave empty to include your oldest data.           |
| End date        | datetime | No       | Only include cycles up to this date and time. Leave empty to include everything up to now.             |
| Maximum results | integer  | No       | How many cycles to return at most. Newest come first. Default: 25.                                     |
| Page cursor     | string   | No       | Continue from where a previous run left off. Paste the token from the last run to fetch the next page. |

#### Outputs

| Field            | Type          | Description                                            |
| ---------------- | ------------- | ------------------------------------------------------ |
| Cycles           | object\_array | The list of daily cycles in the window.                |
| Next page cursor | string        | Token to fetch the next page of cycles, if any remain. |

### Get My Profile

Get the basic profile of the connected WHOOP member: first name, last name, and email.

**Required permissions:** `read:profile`.

#### Inputs

No input fields are required in this catalog entry.

#### Outputs

| Field      | Type    | Description                         |
| ---------- | ------- | ----------------------------------- |
| User ID    | integer | The member's numeric WHOOP user ID. |
| Email      | string  | The member's email address.         |
| First name | string  | The member's first name.            |
| Last name  | string  | The member's last name.             |

### Get Body Measurements

Get your height, weight, and WHOOP-calculated maximum heart rate.

**Required permissions:** `read:body_measurement`.

#### Inputs

No input fields are required in this catalog entry.

#### Outputs

| Field                | Type    | Description                                             |
| -------------------- | ------- | ------------------------------------------------------- |
| Height (m)           | number  | The member's height in meters.                          |
| Weight (kg)          | number  | The member's weight in kilograms.                       |
| Max heart rate (bpm) | integer | The maximum heart rate WHOOP calculated for the member. |

### Get Sleep by ID

Fetch a single sleep session by its unique ID. Useful for looking up the full details of a specific sleep (for example, one surfaced by the New Sleep trigger).

**Required permissions:** `read:sleep`.

#### Inputs

| Field    | Type   | Required | Description                                  |
| -------- | ------ | -------- | -------------------------------------------- |
| Sleep ID | string | Yes      | The unique ID of the sleep session to fetch. |

#### Outputs

| Field               | Type    | Description                                          |
| ------------------- | ------- | ---------------------------------------------------- |
| Sleep ID            | string  | The unique ID of the sleep session.                  |
| Cycle ID            | integer | The cycle this sleep belongs to.                     |
| Start               | string  | When the sleep started.                              |
| End                 | string  | When the sleep ended.                                |
| Is nap              | boolean | Whether this session was a nap.                      |
| Score state         | string  | Whether the sleep is scored, pending, or unscorable. |
| Sleep performance % | number  | Time asleep vs sleep needed (0-100%).                |
| Sleep efficiency %  | number  | Time asleep vs time in bed (0-100%).                 |

### Get Workout by ID

Fetch a single workout by its unique ID, including sport, strain, heart rate, and energy expended (in kilojoules).

**Required permissions:** `read:workout`.

#### Inputs

| Field      | Type   | Required | Description                            |
| ---------- | ------ | -------- | -------------------------------------- |
| Workout ID | string | Yes      | The unique ID of the workout to fetch. |

#### Outputs

| Field          | Type    | Description                                            |
| -------------- | ------- | ------------------------------------------------------ |
| Workout ID     | string  | The unique ID of the workout.                          |
| Sport          | string  | The sport performed.                                   |
| Start          | string  | When the workout started.                              |
| End            | string  | When the workout ended.                                |
| Score state    | string  | Whether the workout is scored, pending, or unscorable. |
| Strain         | number  | Cardiovascular strain (0-21).                          |
| Avg heart rate | integer | Average heart rate during the workout.                 |
| Max heart rate | integer | Max heart rate during the workout.                     |
| Kilojoules     | number  | Energy expended (kJ).                                  |

### Get Cycle by ID

Fetch a single physiological cycle (WHOOP day) by its ID, including day strain and heart rate.

**Required permissions:** `read:cycles`.

#### Inputs

| Field    | Type    | Required | Description                   |
| -------- | ------- | -------- | ----------------------------- |
| Cycle ID | integer | Yes      | The ID of the cycle to fetch. |

#### Outputs

| Field          | Type    | Description                                          |
| -------------- | ------- | ---------------------------------------------------- |
| Cycle ID       | integer | The unique ID of the cycle.                          |
| Start          | string  | When the cycle started.                              |
| End            | string  | When the cycle ended (absent while in progress).     |
| Score state    | string  | Whether the cycle is scored, pending, or unscorable. |
| Strain         | number  | Day strain (0-21).                                   |
| Avg heart rate | integer | Average heart rate during the cycle.                 |
| Max heart rate | integer | Max heart rate during the cycle.                     |
| Kilojoules     | number  | Energy expended (kJ).                                |

### Get Recovery by Cycle

Fetch the recovery for a specific cycle, including recovery percentage, resting heart rate, and HRV. Recoveries are keyed by cycle, so pass the cycle ID.

**Required permissions:** `read:recovery`.

#### Inputs

| Field    | Type    | Required | Description                                  |
| -------- | ------- | -------- | -------------------------------------------- |
| Cycle ID | integer | Yes      | The ID of the cycle whose recovery to fetch. |

#### Outputs

| Field              | Type    | Description                                             |
| ------------------ | ------- | ------------------------------------------------------- |
| Cycle ID           | integer | The cycle this recovery belongs to.                     |
| Sleep ID           | string  | The sleep this recovery is derived from.                |
| Score state        | string  | Whether the recovery is scored, pending, or unscorable. |
| Recovery %         | number  | How recovered the member is (0-100%).                   |
| Resting heart rate | number  | Resting heart rate.                                     |
| HRV (ms)           | number  | Heart-rate variability (RMSSD) in ms.                   |
| Created at         | string  | When the recovery was recorded.                         |

### Get Sleep for Cycle

Fetch the sleep that belongs to a specific cycle (WHOOP day). Pass the cycle ID to get that day's sleep.

**Required permissions:** `read:sleep`.

#### Inputs

| Field    | Type    | Required | Description                               |
| -------- | ------- | -------- | ----------------------------------------- |
| Cycle ID | integer | Yes      | The ID of the cycle whose sleep to fetch. |

#### Outputs

| Field               | Type    | Description                                          |
| ------------------- | ------- | ---------------------------------------------------- |
| Sleep ID            | string  | The unique ID of the sleep session.                  |
| Cycle ID            | integer | The cycle this sleep belongs to.                     |
| Start               | string  | When the sleep started.                              |
| End                 | string  | When the sleep ended.                                |
| Is nap              | boolean | Whether this session was a nap.                      |
| Score state         | string  | Whether the sleep is scored, pending, or unscorable. |
| Sleep performance % | number  | Time asleep vs sleep needed (0-100%).                |
| Sleep efficiency %  | number  | Time asleep vs time in bed (0-100%).                 |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### New Recovery

Fires when WHOOP scores a new recovery for the connected member. Polls the recovery collection and emits each newly scored recovery once.

**Required permissions:** `read:recovery`.

#### Event inputs

| Field              | Type     | Required | Description                                                         |
| ------------------ | -------- | -------- | ------------------------------------------------------------------- |
| Cycle ID           | integer  | Yes      | The cycle this recovery belongs to. Default: 0.                     |
| Sleep ID           | string   | Yes      | The sleep session this recovery is derived from. Default: .         |
| Score state        | string   | Yes      | Whether the recovery is scored, pending, or unscorable. Default: .  |
| Recovery %         | number   | No       | How recovered the member is (0-100%).                               |
| Resting heart rate | number   | No       | The member's resting heart rate.                                    |
| HRV (ms)           | number   | No       | Heart-rate variability (RMSSD) in milliseconds.                     |
| Created at         | datetime | Yes      | When the recovery was recorded. Default: 0001-01-01 00:00:00+00:00. |

#### Outputs

| Field              | Type     | Description                                             |
| ------------------ | -------- | ------------------------------------------------------- |
| Cycle ID           | integer  | The cycle this recovery belongs to.                     |
| Sleep ID           | string   | The sleep session this recovery is derived from.        |
| Score state        | string   | Whether the recovery is scored, pending, or unscorable. |
| Recovery %         | number   | How recovered the member is (0-100%).                   |
| Resting heart rate | number   | The member's resting heart rate.                        |
| HRV (ms)           | number   | Heart-rate variability (RMSSD) in milliseconds.         |
| Created at         | datetime | When the recovery was recorded.                         |

### New Sleep

Fires when WHOOP records a new sleep session for the connected member. Polls the sleep collection and emits each new session once.

**Required permissions:** `read:sleep`.

#### Event inputs

| Field               | Type     | Required | Description                                                     |
| ------------------- | -------- | -------- | --------------------------------------------------------------- |
| Sleep ID            | string   | Yes      | The unique ID of the sleep session. Default: .                  |
| Cycle ID            | integer  | Yes      | The cycle this sleep belongs to. Default: 0.                    |
| Start               | datetime | Yes      | When the sleep started. Default: 0001-01-01 00:00:00+00:00.     |
| End                 | datetime | Yes      | When the sleep ended. Default: 0001-01-01 00:00:00+00:00.       |
| Is nap              | boolean  | Yes      | Whether this session was a nap. Default: false.                 |
| Score state         | string   | Yes      | Whether the sleep is scored, pending, or unscorable. Default: . |
| Sleep performance % | number   | No       | Time asleep vs sleep needed (0-100%).                           |
| Sleep efficiency %  | number   | No       | Time asleep vs time in bed (0-100%).                            |

#### Outputs

| Field               | Type     | Description                                          |
| ------------------- | -------- | ---------------------------------------------------- |
| Sleep ID            | string   | The unique ID of the sleep session.                  |
| Cycle ID            | integer  | The cycle this sleep belongs to.                     |
| Start               | datetime | When the sleep started.                              |
| End                 | datetime | When the sleep ended.                                |
| Is nap              | boolean  | Whether this session was a nap.                      |
| Score state         | string   | Whether the sleep is scored, pending, or unscorable. |
| Sleep performance % | number   | Time asleep vs sleep needed (0-100%).                |
| Sleep efficiency %  | number   | Time asleep vs time in bed (0-100%).                 |

### New Workout

Fires when WHOOP records a new workout for the connected member. Polls the workout collection and emits each new workout once.

**Required permissions:** `read:workout`.

#### Event inputs

| Field          | Type     | Required | Description                                                       |
| -------------- | -------- | -------- | ----------------------------------------------------------------- |
| Workout ID     | string   | Yes      | The unique ID of the workout. Default: .                          |
| Sport          | string   | Yes      | The sport performed. Default: .                                   |
| Start          | datetime | Yes      | When the workout started. Default: 0001-01-01 00:00:00+00:00.     |
| End            | datetime | Yes      | When the workout ended. Default: 0001-01-01 00:00:00+00:00.       |
| Score state    | string   | Yes      | Whether the workout is scored, pending, or unscorable. Default: . |
| Strain         | number   | No       | Cardiovascular strain of the workout (0-21).                      |
| Avg heart rate | integer  | No       | Average heart rate during the workout.                            |
| Max heart rate | integer  | No       | Max heart rate during the workout.                                |

#### Outputs

| Field          | Type     | Description                                            |
| -------------- | -------- | ------------------------------------------------------ |
| Workout ID     | string   | The unique ID of the workout.                          |
| Sport          | string   | The sport performed.                                   |
| Start          | datetime | When the workout started.                              |
| End            | datetime | When the workout ended.                                |
| Score state    | string   | Whether the workout is scored, pending, or unscorable. |
| Strain         | number   | Cardiovascular strain of the workout (0-21).           |
| Avg heart rate | integer  | Average heart rate during the workout.                 |
| Max heart rate | integer  | Max heart rate during the workout.                     |

## Important behavior

If an operation is denied, check the connection’s granted permissions and the account’s access in the provider. Reauthorize the connection when it needs additional permissions.

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/whoop.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
