Sign in

v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB
Aliases

Gets all aliases of a device

Gets all aliases of a device identified by the trackingId.

If the request is supplied with a type query parameter, the response will contain only aliases of the given type.

get/aliases/v2/{trackingId}

Query parameters

pageTokenstring

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

countinteger

The number of items to return per page.

typestring

An alias type

Response

Successful

The aliases were successfully retrieved.

countinteger

The number of items in the response.

pageTokenstring

A token that can be used to retrieve the next page of the response.

dataobject

A map of key-value pairs where the key is the type of the alias and the value is an array of externalIds.

Example response

{
  "data": {
    "cargoId": [
      "123-456"
    ],
    "engines": [
      "de7a0e9a-2e86-11e8-b20f-6c400892e894",
      "dfee3968-2e86-11e8-b4e0-6c400892e894"
    ]
  }
}