v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB
Aliases

Gets all aliases

Gets all aliases of a project.

If type query parameter is provided, the response will contain only aliases of the given type.

If externalId query parameter is specified, the response will contain only aliases that match the given external ID. The following wildcards can be used: '*' matches any number of any characters, '?' matches a single character.

If after query parameter is provided, the successful response will only contain aliases that were created after the specified timestamp. Parameters after and pageToken are mutually exclusive and cannot be provided at the same time.

The returned results are sorted in ascending order by the alias creation time.

get/aliases/v2

Query parameters

pageTokenstring

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

countinteger

The number of items to return per page.

afternumber

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

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.

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.

Example response

{
  "data": [
    {
      "aliases": {
        "cargoId": [
          "123-456"
        ],
        "engines": [
          "de7a0e9a-2e86-11e8-b20f-6c400892e894",
          "dfee3968-2e86-11e8-b4e0-6c400892e894"
        ]
      },
      "trackingId": "HERE-c47c0d1d-89fd-4961-b341-3eb109f58d19"
    },
    {
      "aliases": {
        "engines": [
          "5219bfc6-9779-4901-922a-e53a7c01037e"
        ]
      },
      "trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
    }
  ]
}
All 216 operations