v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB
Shadows

Gets a device shadow

Gets the trackingId device shadow that contains both reported and desired shadows.

If a shipmentId is used instead of a trackingId, it will return a shadow of the device that was most recently active for the shipment. If the shipment is still pending or it has been cancelled or completed, an empty shadow will be returned.

get/shadows/v2/{trackingId}

Path parameters

trackingIdstring required

This is a unique ID associated with the device data in HERE Tracking. For physical devices the trackingId gets assigned to a device when the device is claimed by a user, and for virtual devices it is an external device ID along with the device project appId. Alternatively, a valid shipmentId may be used.

Response

Successful

The device shadow was successfully retrieved.

Example response

{
  "reported": {
    "system": {
      "client": {
        "accelerometerSensorRange": [
          2
        ],
        "diagnosticscode": 0,
        "diskquota": 256,
        "firmware": "heroltexx...",
        "hasAccelerometerSensor": true,
        "hasAttachSensor": true,
        "hasHumiditySensor": true,
        "hasNoBattery": false,
        "hasPressureSensor": true,
        "hasTamperSensor": true,
        "hasTemperatureSensor": true,
        "homenetwork": [],
        "manufacturer": "Samsung",
        "model": "SM-G930F",
        "name": "HERE Tracker",
        "platform": "Android",
        "version": "1.6.1"
      },
      "imsi": "123456789012345",
      "phoneNumber": "+491234567890"
    }
  }
}