---
title: "Get sleep datasets"
method: GET
path: "/api/v5/sleep-dataset/"
tags: ["Sleep datasets"]
---

# Get sleep datasets

`GET /api/v5/sleep-dataset/`

Get current user sleep datasets

## Query parameters

- `start_date` string, date
- `end_date` string, date

## Response `200`

Successful Response

- ListOfSleepDatasetInResponse
  - `sleepDatasets` SleepDataset[], required
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `deletedAt` string, date-time
    - `id` integer
    - `sleepData` string
    - `night` string, date-time
    - `userId` integer, required
    - `deepSleep` integer, required
    - `lightSleep` integer, required
    - `remSleep` integer
    - `restless` integer, required
    - `wakeUp` string, date-time
    - `snoozes` integer
    - `alarmType` string
    - `snoozeLock` boolean
    - `validated` boolean
    - `archived` boolean
    - `plotData` string[], required
    - `convertedPlotData` number[]
    - `inode` string
    - `deviceId` integer
    - `userDate` string, date
    - `sleepDataAttachmentFileName` string
    - `sleepDataAttachmentContentType` string
    - `sleepDataAttachmentFileSize` string, date-time
    - `wakeupScore` number
    - `sleepDuration` number
    - `deepSleepDuration` number
    - `lightSleepDuration` number
    - `remSleepDuration` number
    - `restlessDuration` number
    - `awakeningsCount` integer
    - `deepScore` number
    - `lightScore` number
    - `remScore` number
    - `sleepCompositionScore` number
    - `sleepDurationScore` number
    - `restlessScore` number
    - `overallScore` number

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/pavlok/apis/pavlok-api-v5.md) · [All operations](https://skmtc.net/pavlok/apis/pavlok-api-v5/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pavlok/pavlok-api-v5/versions/3d192098b1ac/schema)