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

List projects

 

Service version: 1 (Public Preview)
Last edit: 2019.03.27

On this page

Purpose

This endpoint obtains a list of tuples representing a user's projects. Each tuple contains a single project'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/projects?key=Your_API_Key

curl command

curl -v -XGET -H 'https://baseURL/geofencing/versionNumber/projects?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.

Examples

Example: List all projects available to the requesting user.

Request format

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

Response body

{
  "projects": [
    {
      "id": "a project_id",
      "name": "a project_name""
    }
      ...
  ]
}

▲ Return to top

Response data

Response body

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

{
  "projects": [
    {
      "id": "project_id",
      "name": "project_name"
    }
      ...
  ]
}

Response fields

The following data tables describe all of the fields that can appear in a Response.

Primary fields
Field Description
projects[]
array
The list of projects in a configuration.
projects[] array
Field Description
id
string
The UUID of the project.
name
string
The project's name.

HTTP Response codes

Code Meaning and possible causes
200 OK
400 Malformed request: Malformed syntax. Possible causes include: The requested syntax is not available.
401 Unauthorized: Configuration not found.

  • The configuration does not exist in the database.
  • The user has not registered an Admin Key.
403 Forbidden: The supplied API Key is not valid for this Request.
500 Internal Server Error: There is a problem with the TomTom Geofencing API service.

▲ Return to top

You are here