TomTom LogoDocs
Products
Resources
Pricing
Sign in
Map Feedback API
Documentation
API Explorer

Get feedback by reference ID

Request access
Service version: 1.0.0Last edit: 2026.09.23

Important note
This API is not available as part of our free evaluation or Pay As You Grow (PAYG) offering. Click the Request Access button above to contact our Sales team.

Purpose

This call can be used to get feedback data for a given reference ID.

How to request data

HTTP method: GET

  • Constants and parameters enclosed in curly brackets { } must be replaced with their values.
  • The generic URL format is as follows.

URL request format

post
URL request format
https://{baseUrl}/maps/orbis/feedback/reference-id/{referenceId}?key={API-key}&apiVersion={version}

Response data

The attachments list holds the files added to this feedback. It contains information about each file only, not the file itself; use Get attachment download URL to read a file. The list is empty when the feedback has no attachments, and files that were deleted are no longer listed. See Attachments.

Response codes

HTTP Code

Message

Description

Sample response

200

OK

Feedback details retrieved successfully

{
   "feedback": {
       "feedbackId": "7049aa04-91bd-4ad3-8085-bd8bec318905",
       "referenceId": "123001",
       "geometry": "POINT(19.4560 51.7592)",
       "kind": "Example_Kind",
       "data": "ewogICJ0aXRsZSI6ICJQcm9ibGVtIG9uIE1hcCIsCiAgImNyZWF0ZWREYXRlIjogIjIwMjUtMDYtMDYiLAogICJ1c2VyQ29tbWVudCI6ICJUaGlzIHJvYWQgc2hvdWxkIGJlIGRlbGV0ZWQuIiwKICAibG9jYXRpb24iOiAiUE9JTlQoMTkuNDU2MCA1MS43NTkyKSIsCn0=",
       "severity": 1,
       "labels": [
           "Label1"
       ],
       "status": "NEW",
       "statusReason": "",
       "products": [
         {
           "name": "Product A",
           "version": "2025_001"
         },
         {
           "name": "Product B",
           "version": "2025_002"
         }
       ],
       "createdAt": "2025-06-06T12:07:41.114166",
       "updatedAt": "2025-06-06T12:07:41.114166"
   },
   "attachments": [
       {
           "attachmentId": "6b48dd3c-6d0c-4b0a-9a6e-1f1c0e2a51f4",
           "feedbackId": "7049aa04-91bd-4ad3-8085-bd8bec318905",
           "status": "ACTIVE",
           "displayFilename": "missing-road-sign.png",
           "contentType": "image/png",
           "sizeBytes": 20480,
           "createdAt": "2025-06-06T12:09:12.441038"
       }
   ]
}

403

Forbidden

Access denied

{
    "detailedError": {
        "code": "Forbidden",
        "message": "You are not allowed to access this endpoint"
    }
}

404

Not found

Feedback not found

{
    "errorText": "Feedback with feedback id=7049aa04-91bd-4ad3-8085-bd8bec318905 not found",
    "detailedError": {
        "code": "NOT_FOUND",
        "message": "Feedback with feedback id=7049aa04-91bd-4ad3-8085-bd8bec318905 not found"
    },
    "httpStatusCode": 404
}

500

Internal Server Error

Internal server error

{
    "errorText": "An unexpected error has occurred. Please try again later.",
    "detailedError": {
        "code": "INTERNAL_SERVER_ERROR",
        "message": "An unexpected error has occurred. Please try again later."
    },
    "httpStatusCode": 500
}