Get object details

Decommission notice

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 request format

1
https://{baseURL}/geofencing/{versionNumber}/objects/{objectId}?key={Your_API_Key}

curl command request format

1
curl 'https://{baseURL}/geofencing/{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.

Response data

Response body

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

1
{
2
  "name": "object_name",
3
  "id": "object_id",
4
  "defaultProject": "project_id",
5
  "properties": {
6
    "key": "value"
7
    ...
8
  }
9
}

Response fields

The following table describes all of the response fields.

Example

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

URL request example

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

Response body example

1
{
2
  "name": "Support car 1",
3
  "id": "cfde72d8-4b9f-4f6d-83c8-87ae0465fd5d",
4
  "defaultProject": "4dee65b0-bd0a-47fd-ad12-27231fd780fb",
5
  "properties": {
6
    "embeddedId": "EL 11111",
7
    "maxSpeedKmh": 70,
8
    "driver": "John Doe"
9
  }
10
}