Gets all locations

get

https://tracking.hereapi.com/locations/v4

Gets all locations of the project.

Query Params

limit

integer

1 to 100

Defaults to 100

The number of items to return per page

pageToken

string

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

geofenceId

uuid

Filter the results by geofenceId

name

string

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

street

string

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

city

string

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

postalCode

string

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

state

string

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

country

string

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

locationId

string

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

externalLocationId

string

length between 1 and 100

Filter locations by external location id. Matching is case-insensitive if wildcards are used, otherwise case-sensitive. The following wildcards can be used: '*' matches any number of any characters, '?' matches any single character.

sort

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.

projectId

string

length between 1 and 50

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.

Headers

X-Request-Id

uuid

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

Must be a valid UUIDv4.

Responses

200Response 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.

400Bad request The request object is in an incorrect format or has values that are invalid or out of range. If available, further error details are provided in the response body.

401Unauthorized The request did not provide correct authentication details

403Forbidden The account does not have the correct privileges