List projects
Service version: 1
Last edit: 2019.09.18
On this page
- ▸ Purpose
- ▸ Request data
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.
https://baseURL/geofencing/versionNumber/projects?key=Your_API_Key
curl command
curl '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""
}
...
]
}
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.
|
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. |