v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB

Shadows

Gets a batch of device shadows

Gets device shadows for multiple devices. One can get shadows for a maximum of 100 devices per request.

In case after parameter is provided, only the device shadows that were modified on or after the specified timestamp will be retrieved.

post/shadows/v2/batch

Query parameters

afternumber

Milliseconds elapsed since 1 January 1970 00:00:00 UTC. The accepted range is from 0 to the current time.

appIdstring

Application identifier. Used together with an external ID to identify a virtual device.

Headers

X-Request-Idstring uuid

ID used for correlating requests within HERE Tracking. Used for logging and error reporting.

Must be a valid UUIDv4.

Request body

string[] required

An array of trackingIds of devices

Example request

[
  "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6",
  "HERE-b0146d7b-2e46-4cee-bc71-6da03ba2da85"
]

Response

Successful

The response body contains a list of device shadows accompanied by statusCode and trackingId of the associated device. The returned shadow objects are in same order as the trackingIds provided in the request.

In case of an error, each trackingId has a separate status code:

403 - Forbidden
404 - Device not found

appIdstring

Virtual device application ID, only present when the device is virtual

externalIdstring

Virtual device external ID, only present when the device is virtual

statusCodeinteger

trackingIdstring

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.

Example response

[
  {
    "body": {
      "desired": {},
      "reported": {
        "position": {
          "accuracy": 30,
          "lat": 40,
          "lng": 30.2
        },
        "system": {
          "phoneNumber": "+4917012345"
        }
      }
    },
    "statusCode": 200,
    "trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
  },
  {
    "statusCode": 404,
    "trackingId": "HERE-b0146d7b-2e46-4cee-bc71-6da03ba2da85"
  }
]