GET /locations/v4

X-Request-Id (string, header, optional)

ID used for correlating requests within HERE Tracking. Used for logging and error reporting. Must be a valid UUIDv4.

city (string, query, optional)

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

country (string, query, optional)

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

externalLocationId (string, query, optional)

Filter locations by external location id

Constraints: {'minLength': 1, 'maxLength': 100}

geofenceId (string, query, optional)

Filter the results by `geofenceId`

limit (integer, query, optional, default: 100)

The number of items to return per page

Constraints: {'minimum': 1, 'maximum': 100}

locationId (string, query, optional)

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

name (string, query, optional)

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

pageToken (string, query, optional)

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

postalCode (string, query, optional)

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.

projectId (string, query, optional)

Constraints: {'minLength': 1, 'maxLength': 50}

sort (?, query, optional)

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.

state (string, query, optional)

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

street (string, query, optional)

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.