# Get sleep (WHOOP)

Operation ID: `connectors.whoopGetSleep`

Get sleep via WHOOP. Returns a WhoopSleep record.

## Public method

`getSleep`

Signature: `connectors.whoop.createClient(config).getSleep(body)`

Return type: `Promise<WhoopSleepResponse>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/whoop/get-sleep`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`WhoopGetSleepRequest`](../models/WhoopGetSleepRequest.md) | Yes |  |  |  | No |  |

Request model: [`WhoopGetSleepRequest`](../models/WhoopGetSleepRequest.md)

## Request example

```json
{
  "base_url": "https://example.com/resource",
  "client_id": "12345",
  "client_secret": "example-client-secret",
  "mode": "sandbox",
  "sleep_id": "12345",
  "user_access_token": "example-access-token"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`WhoopSleep`](../models/WhoopSleep.md) | application/json | Successful response |

## Success response examples

### 200

```json
{
  "created_at": "example-created-at",
  "cycle_id": 1,
  "end": "example-end",
  "id": "12345",
  "nap": true,
  "score": {},
  "score_state": "MA",
  "start": "example-start",
  "timezone_offset": "example-timezone-offset",
  "updated_at": "example-updated-at",
  "user_id": 1,
  "v1_id": 1
}
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Connector validation rejected the payload, or a required field was missing or of the wrong type. |
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The HealthCloud bearer token is missing or invalid, or the vendor rejected the supplied connector credentials. |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The connector failed unexpectedly. |
| `502` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor returned an application or transport-level failure. |
| `504` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor did not respond within the connector timeout. |

## Error examples

### 400 — Invalid request

```json
{
  "error": "Invalid request"
}
```

### 401 — Authorization required

```json
{
  "error": "Authorization required"
}
```

### 500 — Internal error

```json
{
  "error": "Internal error"
}
```

### 502 — Upstream vendor error

```json
{
  "error": "Upstream vendor error"
}
```

### 504 — Upstream timeout

```json
{
  "error": "Upstream timeout"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
import type { WhoopGetByIdRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "base_url": "https://example.com/resource",
  "client_id": "12345",
  "client_secret": "example-client-secret",
  "mode": "sandbox",
  "sleep_id": "12345",
  "user_access_token": "example-access-token"
};

const result = await connectors.whoop.createClient(config).getSleep(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"base_url":"https://example.com/resource","client_id":"12345","client_secret":"example-client-secret","mode":"sandbox","sleep_id":"12345","user_access_token":"example-access-token"}' \
  'https://dev-api-connectors.health.cloud/connectors/whoop/get-sleep'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.