List current options

Purpose

This endpoint is used to list settings and statuses.

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}/notifications/{versionNumber}/settings?key={Your_API_Key}

URL request example

https://api.tomtom.com/notifications/1/settings?key={Your_API_Key}

curl command request example

curl 'https://api.tomtom.com/notifications/1/settings?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

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

1{
2  "privacySettings": {
3    "deleteAllHistoryMessagesBefore": "ISO8601_timestamp",
4    "deleteAllHistoryMessagesBeforeStatus": "<string>"
5  }
6}

Response fields

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

Response codes

Example

Request URL

https://api.tomtom.com/notifications/1/settings?key={Your_API_Key}

Response body

1{
2  "privacySettings": {
3    "deleteAllHistoryMessagesBefore": "2019-07-10T12:30:00.000+00:00",
4    "deleteAllHistoryMessagesBeforeStatus": "DELETED"
5  }
6}