Get object details

Service version: 1
Last edit: 2022.07.21

Purpose

This endpoint requests all details about a single object.

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/{objectId}?key={Your_API_Key}

curl command format

GET
Request curl command
curl 'https://{baseURL}/locationHistory/{versionNumber}/objects/{objectId}?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.
objectId
string
The object id to gather details for.
Value: A UUID.

Response data

Response body

The following JSON code block demonstrates a successful response from the API server.

Response body - JSON
1{
2 "name": "object_name",
3 "id": "object_id",
4 "properties": {
5 "key": "value"
6 ...
7 }
8}

Response fields

The following table describes all of the response fields.

Primary fieldsDescription
name
string
The name of the object.
id
string
The UUID of the object.
properties
object
(Optional) An object containing user-defined properties. Its content varies between objects.

Example

Get details of the 'Support car 1' object (id: cfde72d8-4b9f-4f6d-83c8-87ae0465fd5d).

Request URL

GET
Request example
https://api.tomtom.com/locationHistory/1/objects/cfde72d8-4b9f-4f6d-83c8-87ae0465fd5d?key={Your_API_Key}

Response body

Response body - JSON
1{
2 "name": "Support car 1",
3 "id": "cfde72d8-4b9f-4f6d-83c8-87ae0465fd5d",
4 "properties": {
5 "embeddedId": "EL 11111",
6 "maxSpeedKmh": 70,
7 "driver": "John Doe"
8 }
9}