v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB
Shadows

Gets all shadows

Gets all device shadows of a project.

get/shadows/v4

Query parameters

projectIdstring

Project ID. Any HERE Tracking user must be a member of a Tracking project. The project ID can be implicitly resolved if the user calling the API is a member of a single project. If the user is a member of multiple projects, the projectId query parameter needs to be specified explicitly.

pageTokenstring

A token from the previously returned response to retrieve the specified page.

limitinteger

The number of items to return per page

afterstring date-time

If provided returns the shadows for which reported.timestamp is greater than given after parameter.

sortstring

Defines how the items are sorted. The default sort is sort=trackingId:asc

bboxnumber[]

Limit search to shadows, whose position intersects the given bounding box. The bbox array consist of latitude and longitude of Northwest and Southeast corners.

Headers

X-Request-Idstring uuid

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

Must be a valid UUIDv4.

Response

Response body contains an array of shadows along with tracking ID, count indicating the number of returned items, and next page token if available. For virtual devices, a combination of app ID and external ID is provided instead of tracking ID.

countinteger required

Number of items returned in the response

limitinteger required

Maximum number of items as specified in request

nextPageTokenstring

Token to fetch the next page (if exists)

Example response

{
  "items": [
    {
      "shadow": {
        "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"
          }
        }
      }
    }
  ]
}