Sign in

v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB
Locations

Gets all locations

Gets all locations of the project.

get/locations/v4

Query parameters

limitinteger

The number of items to return per page

pageTokenstring

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

geofenceIdstring uuid

Geofence ID

Filter the results by geofenceId

namestring

Filter locations by name. Matching is case-insensitive. The following wildcards can be used: '*' matches any number of any characters, '?' matches any single character.

streetstring

Filter locations by street address. Matching is case-insensitive. The following wildcards can be used: '*' matches any number of any characters, '?' matches any single character.

citystring

Filter locations by city. Matching is case-insensitive. The following wildcards can be used: '*' matches any number of any characters, '?' matches any single character.

postalCodestring

Filter locations by postal code. Matching is case-insensitive. The following wildcards can be used: '*' matches any number of any characters, '?' matches any single character.

statestring

Filter locations by state. Matching is case-insensitive. The following wildcards can be used: '*' matches any number of any characters, '?' matches any single character.

countrystring

Filter locations by country. Matching is case-insensitive. The following wildcards can be used: '*' matches any number of any characters, '?' matches any single character.

locationIdstring

Filter locations by locationId wildcard. The following wildcards can be used: '*' matches any number of any characters, '?' matches any single character.

string
OR
string[]

A paramater to specify field to sort by and order. The following format can be used: 'name:asc' sort by name in ascending order, 'steet:desc' sort by street in descending order. Allowed fields to sort by: locationId, name, street, city, postalCode, state, country.

externalLocationIdstring

External location id in external cloud

Filter locations by external location id

Response

Response body contains an array of location objects, count indicating the number of returned items, limit indicating the requested maximum amount of records to be returned and pageToken for the next page if available.

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)

totalinteger

Total number of locations for query

Example response

{
  "items": [
    {
      "description": "Rostock Port Hafenbecken C",
      "geofenceId": "57713e50-194e-4803-8ca6-1e794e916094",
      "location": {
        "lat": 54.155147,
        "lng": 12.12204
      },
      "locationId": "LOC-61a3fba0-cb44-405f-816c-c2aec73a1add",
      "name": "Rostock Port"
    }
  ]
}