List projects

Service version: 1
Last edit: 2022.09.01

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

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

curl command request format

'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.
  • The order of request parameters is not important.

Note: There are no optional parameters in this endpoint.

Required parameters

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.

Response data

Response body

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

1{
2 "projects": [
3 {
4 "id": "project_id",
5 "name": "project_name"
6 }
7 ...
8 ]
9}

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.

Response codes

Code

Meaning & 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.

Example

List all projects available to the requesting user.

URL request example

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

Response body example

1{
2 "projects": [
3 {
4 "id": "project_id",
5 "name": "project_name"
6 }
7 ...
8 ]
9}