devices

Description

The /devices endpoint enables retrieval of a user's device information, including G4, G5, G6, and G7 standalone receivers, the G5, G6, and G7 mobile apps, and transmitters. The response is an array of all receiver-type devices contributing data to the specified time window, including the alerts and settings associated with each receiver. Scopes and Access

Resource

GET /v3/users/self/devices

Authorization

OAuth 2.0 bearer token; see the Authentication section for details on this workflow.

Query Parameters

There are no query parameters for the devices endpoint. The response will return all devices associated with a Dexcom account along with the settings for each device.

Notes

The unit enumerations vary between endpoints. For devices, the values are as follows:

  • unknown
  • grams
  • mg/dL
  • mmol/L
  • mg/dL/min
  • mmol/L/min
  • minutes
  • units

For the systemTime and displayTime response fields, records sourced from mobile apps (with displayDevice of “iOS” or “android”) will have UTC offsets; records sourced from receivers (with displayDevice of “receiver”) will not have UTC offsets.

SecurityBearerAuth
Responses
200

Ok

Response Schema: application/json
recordType
required
string
recordVersion
required
string
userId
required
string
required
Array of objects (com.dexcom.partner.api.models.proto.v3.device.Device)
Array
lastUploadDate
required
string <date-time>
transmitterId
string or null
transmitterGeneration
required
string
Enum: "unknown" "g4" "g5" "g6" "g6+" "dexcomPro" "g7"
displayDevice
required
string
displayApp
string or null
required
Array of objects (com.dexcom.partner.api.models.proto.v3.alert_schedule.DeviceAlertSchedule)
Array
required
object (com.dexcom.partner.api.models.proto.v3.alert_schedule.DeviceAlertScheduleSettings)
alertScheduleName
required
string
isEnabled
required
boolean
isDefaultSchedule
required
boolean
startTime
required
string
endTime
required
string
daysOfWeek
required
Array of strings
Items Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"
isActive
boolean or null
object (com.dexcom.partner.api.models.proto.v3.alert_schedule.OverrideSetting)
isOverrideEnabled
boolean or null
mode
string or null
Enum: "unknown" "quiet" "vibrate"
endTime
string or null
required
Array of objects (com.dexcom.partner.api.models.proto.v3.alert_schedule.DeviceAlertSetting)
Array
alertName
required
string
Enum: "unknown" "high" "low" "rise" "fall" "outOfRange" "urgentLow" "urgentLowSoon" "noReadings" "fixedLow"
value
integer or null <int32>
unit
string or null

Please see Notes section above for more information on enumeration values

snooze
integer or null <int32>
enabled
required
boolean
systemTime
string or null <date-time>
displayTime
string or null <date-time>
delay
integer or null <int32>
secondaryTriggerCondition
integer or null <int32>
soundTheme
string or null
Enum: "unknown" "modern" "classic"
soundOutputMode
string or null
Enum: "unknown" "sound" "vibrate" "match"
get/v3/users/self/devices
Request samples
curl -i -X GET \
  https://api.dexcom.com/v3/users/self/devices \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "recordType": "device",
  • "recordVersion": "3.0",
  • "userId": "5b329ebcfbf2f0ba7e49d4c5eb57775468f5ee657ac16fcde07e1fd08197b4c7",
  • "records": [
    • {
      • "transmitterGeneration": "g7",
      • "displayDevice": "android",
      • "displayApp": "G7Android",
      • "lastUploadDate": "2021-11-09T15:57:34Z",
      • "alertSchedules": [
        • {
          • "alertScheduleSettings": {
            • "alertScheduleName": "",
            • "isEnabled": true,
            • "startTime": "00:00",
            • "endTime": "00:00",
            • "isActive": false,
            • "override": {
              • "isOverrideEnabled": true,
              • "mode": "quiet",
              • "endTime": "2021-07-05T10:49:22.123-07:00"
              },
            • "daysOfWeek": [
              • "sunday",
              • "monday",
              • "tuesday",
              • "wednesday",
              • "thursday",
              • "friday",
              • "saturday"
              ]
            },
          • "alertSettings": [
            • {
              • "systemTime": "2021-04-05T17:53:03Z",
              • "displayTime": "2021-04-05T10:52:48-06:59:59",
              • "alertName": "rise",
              • "value": 3,
              • "unit": "mg/dL/min",
              • "snooze": null,
              • "enabled": false,
              • "SecondaryTriggerCondition": 10,
              • "soundTheme": "modern",
              • "soundOutputMode": "matchPhone"
              },
            • {
              • "systemTime": "2021-04-05T17:52:47Z",
              • "displayTime": "2021-04-05T10:53:04-06:59:59",
              • "alertName": "high",
              • "value": 192,
              • "unit": "mg/dL",
              • "snooze": 75,
              • "enabled": true,
              • "SecondaryTriggerCondition": 184,
              • "soundTheme": "modern",
              • "soundOutputMode": "matchPhone"
              }
            ]
          }
        ],
      • "transmitterId": "d55d01d0341ed0ba2cd99b322e8c5b609254f47d10c7cd12b99b4922effeba44"
      }
    ]
}