List objects

Service version: 1
Last edit: 2022.07.21

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 format

GET
Request example
https://{baseURL}/locationHistory/{versionNumber}/objects?key={Your_API_Key}

curl command format

GET
Request curl command
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 parametersDescription
baseURL
string
The base URL for calling the API.
Value: api.tomtom.com
versionNumber
string
Service version.
Value: 1
key
string
An API Key valid for the requested service.
Value: Your valid API Key.

Response data

Response body

Response body - 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
FieldDescription
objects
array
The list of pairs consisting of object UUIDs and names.
objects array
FieldDescription
id
string
The UUID of the object.
name
string
The name of the object.

Example

List all objects available to the user.

Request URL

GET
Request example
https://api.tomtom.com/locationHistory/1/objects?key={Your_API_Key}