Loading…
Retrieve a list of sleep records in the tracker system.
| Permission | Description |
|---|---|
tracker_sleeps.view | View tracker sleep records |
| Name | Type | Required | Description |
|---|---|---|---|
start_date | string | No | Start of the date range (YYYY-MM-DD) |
end_date |
| string |
| No |
| End of the date range (YYYY-MM-DD) |
shared_tracker_id | string | No | ID of a shared tracker record (default: your own data). A share the caller is not party to, or one that does not exist, returns 404: the two are indistinguishable. |
search | string | No | Search by notes |
page | int | No | Page number for pagination |
{
"data": [<tracker sleep resource>, ...],
"links": {<pagination data>},
"meta": {<pagination data>}
}
| Status | Error Type | Reference |
|---|---|---|
| 401 | Unauthorized | Authentication error |
| 403 | Forbidden | Permission error |
| 404 | shared_tracker_id names a share the caller may not read | Not found error |