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

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

curl command request format

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

Response data

Response body

1"objects": [
2  {
3    "id": "object_id",
4    "name": "object_name
5  }
6    ...
7  ]
8}

Response fields

The following table describes all of the fields that can appear in a response.

Example

List all objects available to the user.

URL request example

https://api.tomtom.com/geofencing/1/objects?key={Your_API_Key}

Response body example

1"objects": [
2  {
3    "id": "object_id",
4    "name": "object_name
5  }
6    ...
7  ]
8}