Get an alerts configuration

Request

Retrieve an existing alerts configuration.

Security

sessionToken

Path

userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID of the user who granted follow access.

followerUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID of the care partner to receive alerts.

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/alerts.v1/v1/users/{userId}/followers/{followerUserId}/alerts' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

Alerts Config

Bodyapplication/json

non-empty

uploadIdstring, [ 17 .. 32 ] characters(Upload ID)^([0-9a-f]{32}|upid_[0-9a-f]{12})$

An upload identifier; this field should be the uploadId of the corresponding upload record

Example:"0d92d5c1c22117a18f3620b9e24d3c06"

userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

followedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

urgentLowobject(glucosethreshold.v1)

Blood glucose measurements at or below this value will trigger an immediate and urgent alert.

lowobject(glucosethreshold.v1)

Blood glucose measurements at or below this value will trigger an alert.

highobject(glucosethreshold.v1)

Blood glucose measurements at or above this value will trigger an alert.

noCommunicationobject(delay.v1)

An alert sent when issues prevent the display of CGM data.

notLoopingobject(delay.v1)

An alert sent when the Tidepool Loop app is unable to loop.

Response

{
  "uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
  "userId": "string",
  "followedUserId": "string",
  "urgentLow": {
    "enabled": false,
    "threshold": { … }
  },
  "low": {
    "enabled": false,
    "delay": 0,
    "repeat": 0,
    "threshold": { … }
  },
  "high": {
    "enabled": false,
    "delay": 0,
    "repeat": 0,
    "threshold": { … }
  },
  "noCommunication": {
    "enabled": false,
    "delay": 0
  },
  "notLooping": {
    "enabled": false,
    "delay": 0
  }
}