List objects
Purpose
This endpoint obtains a list of tuples representing the user's objects. Each tuple contains a single object's UUID and name.
Request data
HTTPS method: GET
- Constants and parameters enclosed in curly brackets { } must be replaced with their values.
- Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.
URL request format
get
URL request format
https://{baseURL}/locationHistory/{versionNumber}/objects?key={Your_API_Key}
curl command request format
get
curl command request format
curl 'https://{baseURL}/locationHistory/{versionNumber}/objects?key={Your_API_Key}'
Request parameters
The following table describes the parameters that can be used in a request.
- Required parameters must be used or the call will fail.
- Optional parameters may be used.
- The order of request parameters is not important.
Note: There are no optional parameters in this endpoint.
Required parameters | Description |
---|---|
string | The base URL for calling the API. Value: |
string | Service version. Value: |
string | An API Key valid for the requested service. Value: Your valid |
Response data
Response body
Response body format - JSON
1{2 "objects": [3 {4 "id": "uuid_string",5 "name": "string"6 }7 ]8}
Response fields
The following table describes all of the fields that can appear in a response.
Primary fields | |
---|---|
Field | Description |
array | The list of pairs consisting of object UUIDs and names. |
objects array | |
Field | Description |
string | The UUID of the object. |
string | The name of the object. |
Example
List all objects available to the user.
URL request example
get
URL request example
https://api.tomtom.com/locationHistory/1/objects?key={Your_API_Key}