Skip to content

NOWATCH API (0.9.0)

The NOWATCH API

Download OpenAPI description
index.json
index.yaml
Overview
Languages
Servers
Mock server

https://docs.api.nowatch.tech/_mock/apis/

https://docs.api.nowatch.tech/nowatch/

auth

User authentication

Operations

user

User data routes

Operations

firmware

Firmware updates and downloads

Operations

admin-firmware

Admin firmware management

Operations

measurement

Time series health data (heart rate, temperature, activity, etc.)

Operations

insight

User insights, feedback, and reflections

Operations

session

Activity session tracking

Operations

checkin

User check-ins and wellness tracking

Operations

alarm

User alarm management

Operations

day-feedback

Daily feedback and mood tracking

Operations

sleep

Sleep logs and sleep data

Operations

activity

Sessions wrapper for activities

Operations

intention

Sessions wrapper for intentions

Operations

statistics

Aggregated health statistics

Operations

sharing

Manage sharing your data with other people

Operations

shared

Manage other people's data shared with you

Operations

Get all dashboards shared with the user

Request

Retrieves all dashboards that other users have shared with the authenticated user. For extra context visit: Sharing Context

Security
bearer
curl -i -X GET \
  https://docs.api.nowatch.tech/_mock/apis/v1/shared \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns information about dashboards shared with the user

Bodyapplication/jsonArray [
fromIdstringrequired
fromEmailstringrequired
toIdstringrequired
toEmailstringrequired
sharedSincestring(date-time)required
createdstring(date-time)required
lastUpdatedstring(date-time)required
customNamestringrequired
iconColorstringrequired
customProfilePicturestringrequired
groupIdsArray of stringsrequired

Array of group IDs that the shared user is part of

Example: ["a1b2c3d4-e5f6-7890-1234-567890abcdef"]
lastSyncAtstring(date-time)

Last time data was synchronized from the shared user's mobile app

Example: "2024-01-01T12:00:00.000Z"
]
Response
application/json
[
  {
    "fromId": "string",
    "fromEmail": "string",
    "toId": "string",
    "toEmail": "string",
    "sharedSince": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "customName": "string",
    "iconColor": "string",
    "customProfilePicture": "string",
    "groupIds": [ … ],
    "lastSyncAt": "2024-01-01T12:00:00.000Z"
  }
]

Delete a shared dashboard

Request

Removes a shared dashboard from the authenticated user's list. This effectively stops viewing access to the shared dashboard without notifying the owner. For extra context visit: Sharing Context

Security
bearer
Bodyapplication/jsonrequired
userIdstringrequired

The ID of the user who shared the dashboard

Example: "uid_42de8e6bedc4c4520572e33cad742387FNzK76rO/6weZ7SdXmntf/IKcuWal2Nca++pLMMTIu3QJHrDYDsQ0xJ9NrpntWz5"
curl -i -X DELETE \
  https://docs.api.nowatch.tech/_mock/apis/v1/shared \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "uid_42de8e6bedc4c4520572e33cad742387FNzK76rO/6weZ7SdXmntf/IKcuWal2Nca++pLMMTIu3QJHrDYDsQ0xJ9NrpntWz5"
  }'

Responses

Successful request

Bodyapplication/json
statusstring
Value"success"
Response
application/json
{
  "status": "success"
}

Get all groups owned by the user

Request

Retrieves all groups created by the authenticated user, including the members of each group. Groups allow users to organize their shared dashboards. For extra context visit: Sharing Context

Security
bearer
curl -i -X GET \
  https://docs.api.nowatch.tech/_mock/apis/v1/shared/groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns all groups owned by the user with populated user information

Bodyapplication/jsonArray [
idstringrequired

The unique identifier for the group

Example: "a1b2c3d4-e5f6-7890-1234-567890abcdef"
userIdstringrequired

The ID of the user who owns the group

Example: "a1b2c3d4-e5f6-7890-1234-567890abcdef"
namestringrequired

The name of the group

Example: "My Favorite People"
createdstring(date-time)required

The date and time the group was created

Example: "2023-01-01T12:00:00.000Z"
lastUpdatedstring(date-time)required

The date and time the group was last updated

Example: "2023-01-01T12:00:00.000Z"
userIdsArray of stringsrequired

Array of user IDs that are members of this group

Example: ["a1b2c3d4-e5f6-7890-1234-567890abcdef"]
usersArray of objects(SharedEntity)required

Array of users that are members of this group

users[].​fromIdstringrequired
users[].​fromEmailstringrequired
users[].​toIdstringrequired
users[].​toEmailstringrequired
users[].​sharedSincestring(date-time)required
users[].​createdstring(date-time)required
users[].​lastUpdatedstring(date-time)required
users[].​customNamestringrequired
users[].​iconColorstringrequired
users[].​customProfilePicturestringrequired
users[].​groupIdsArray of stringsrequired

Array of group IDs that the shared user is part of

Example: ["a1b2c3d4-e5f6-7890-1234-567890abcdef"]
users[].​lastSyncAtstring(date-time)

Last time data was synchronized from the shared user's mobile app

Example: "2024-01-01T12:00:00.000Z"
]
Response
application/json
[
  {
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "userId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "name": "My Favorite People",
    "created": "2023-01-01T12:00:00.000Z",
    "lastUpdated": "2023-01-01T12:00:00.000Z",
    "userIds": [ … ],
    "users": [ … ]
  }
]

Create a new group

Request

Creates a new group for organizing shared dashboards. Groups allow users to categorize and manage multiple shared users more efficiently. For extra context visit: Sharing Context

Security
bearer
Bodyapplication/jsonrequired
object(CreateGroupDto)
curl -i -X POST \
  https://docs.api.nowatch.tech/_mock/apis/v1/shared/groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The group has been successfully created

Response
No content

Rename a group

Request

Updates the name of an existing group. The user must own the group to rename it. For extra context visit: Sharing Context

Security
bearer
Path
groupIdstringrequired

The ID of the group to rename

Bodyapplication/jsonrequired
object(CreateGroupDto)
curl -i -X PATCH \
  'https://docs.api.nowatch.tech/_mock/apis/v1/shared/groups/{groupId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The group has been successfully renamed

Response
No content

Delete a group

Request

Deletes a group. The user must own the group to delete it. Deleting a group does not affect the shared dashboards themselves, only the grouping. For extra context visit: Sharing Context

Security
bearer
Path
groupIdstringrequired

The ID of the group to delete

curl -i -X DELETE \
  'https://docs.api.nowatch.tech/_mock/apis/v1/shared/groups/{groupId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful request

Bodyapplication/json
statusstring
Value"success"
Response
application/json
{
  "status": "success"
}

Update custom name and icon color for a shared dashboard

Request

Allows users to personalize how a shared dashboard appears to them by setting a custom name and icon color. This only affects the viewing user's experience and does not change the dashboard for others. For extra context visit: Sharing Context

Security
bearer
Bodyapplication/jsonrequired
userIdstringrequired

The ID of the user who shared the dashboard

customNamestringrequired
iconColorstringrequired
curl -i -X POST \
  https://docs.api.nowatch.tech/_mock/apis/v1/shared/custom \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "string",
    "customName": "string",
    "iconColor": "string"
  }'

Responses

Custom settings updated successfully

Bodyapplication/json
fromIdstringrequired
fromEmailstringrequired
toIdstringrequired
toEmailstringrequired
sharedSincestring(date-time)required
createdstring(date-time)required
lastUpdatedstring(date-time)required
customNamestringrequired
iconColorstringrequired
customProfilePicturestringrequired
groupIdsArray of stringsrequired

Array of group IDs that the shared user is part of

Example: ["a1b2c3d4-e5f6-7890-1234-567890abcdef"]
lastSyncAtstring(date-time)

Last time data was synchronized from the shared user's mobile app

Example: "2024-01-01T12:00:00.000Z"
Response
application/json
{
  "fromId": "string",
  "fromEmail": "string",
  "toId": "string",
  "toEmail": "string",
  "sharedSince": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "lastUpdated": "2019-08-24T14:15:22Z",
  "customName": "string",
  "iconColor": "string",
  "customProfilePicture": "string",
  "groupIds": [
    "a1b2c3d4-e5f6-7890-1234-567890abcdef"
  ],
  "lastSyncAt": "2024-01-01T12:00:00.000Z"
}

Upload custom profile picture for a shared dashboard

Request

Uploads a custom profile picture for a shared dashboard. The user must have access to the shared dashboard. Max file size is 5MB. Allowed formats: jpg, png, webp. For extra context visit: Sharing Context

Security
bearer
Bodymultipart/form-datarequired
userIdstring

The ID of the user who shared the dashboard

filestring(binary)
curl -i -X POST \
  https://docs.api.nowatch.tech/_mock/apis/v1/shared/custom/profile-picture \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F userId=string \
  -F file=string

Responses

Profile picture uploaded successfully

Bodyapplication/json
string
Response
application/json
"string"

Delete custom profile picture for a shared dashboard

Request

Deletes the custom profile picture for a shared dashboard. The user must have access to the shared dashboard. For extra context visit: Sharing Context

Security
bearer
Bodyapplication/jsonrequired
userIdstring

The ID of the user who shared the dashboard

curl -i -X DELETE \
  https://docs.api.nowatch.tech/_mock/apis/v1/shared/custom/profile-picture \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "string"
  }'

Responses

Successful request

Bodyapplication/json
statusstring
Value"success"
Response
application/json
{
  "status": "success"
}

Add a user to a group

Request

Adds a shared user to an existing group. The user to be added must already be sharing their dashboard with the authenticated user. For extra context visit: Sharing Context

Security
bearer
Path
groupIdstringrequired

The ID of the group

Bodyapplication/jsonrequired
userIdstringrequired

ID of the user to add to the group

Example: "a1b2c3d4-e5f6-7890-1234-567890abcdef"
curl -i -X POST \
  'https://docs.api.nowatch.tech/_mock/apis/v1/shared/groups/{groupId}/members' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
  }'

Responses

Successful request

Bodyapplication/json
statusstring
Value"success"
Response
application/json
{
  "status": "success"
}

Remove a user from a group

Request

Removes a shared user from a group. This does not stop the dashboard sharing relationship, it only removes them from the group. For extra context visit: Sharing Context

Security
bearer
Path
groupIdstringrequired

The ID of the group

Bodyapplication/jsonrequired
userIdstringrequired

ID of the user to remove from the group

Example: "a1b2c3d4-e5f6-7890-1234-567890abcdef"
curl -i -X DELETE \
  'https://docs.api.nowatch.tech/_mock/apis/v1/shared/groups/{groupId}/members' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
  }'

Responses

Successful request

Bodyapplication/json
statusstring
Value"success"
Response
application/json
{
  "status": "success"
}

telemetry

Application telemetry data (spans, metrics, logs)

Operations