Sorry, you need to enable JavaScript to visit this website.

List objects

 

Service version: 1.0
Last edit: 2019.09.18

On this page

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

URL format

For ease of viewing and identification:

  • Required constants and parameters are shown in bold text.
  • Optional parameters are shown in plain text.
GET https://baseURL/geofencing/versionNumber/objects?key=Your_API_Key

curl command

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.
  • If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
  • The order of request parameters is not important.
Required parameters
Parameter Description
baseURL
string
The base URL for calling the API.
Value: api.tomtom.com
versionNumber
string
Service version number.
Value: 1
key
string
An API Key valid for the requested service.
Value: Your valid API Key.
Optional parameters
This endpoint does not have any optional parameters.

▲ Return to top

Response data

Response body

{
  "objects": [
    {
      "id": "object_id",
      "name": "object_name
    }
    ...
  ]
}

Response fields

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

Primary fields
Field Description
objects[]
array
The list of pairs consisting of object UUIDs and names.
objects[] array
Field Description
id
string
The UUID of the object.
name
string
The name of the object.

▲ Return to top

Examples

List all objects available to the user.

Request URL

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

▲ Return to top

You are here