/getTour

POST https://api.voxtour.ai/v1/getTour

getTour API allows users to retrieve detailed information about a specific tour using its unique identifier. The response includes the tour's template ID and a list of locations featured in the tour, each with a unique location ID and name.

Key Features

Retrieve detailed information about a tour using its unique ID
Get a list of locations included in the tour
Each location contains a unique ID and name

Example Request

Fetching details for a specific tour using its ID:

{
   "apiKey": "12345678-90ab-cdef-1234-567890abcdef",
   "tourId": "a7b1ac9d-3f64-4bd5-ad84-5cf59a72045b"
}

Request Body

apiKey string Required

A unique authentication key required for API access. This key must be included in every request to authorize and validate usage.

tourId string Required

The unique identifier of the tour for which details are requested.

Example Response

Returns details of the requested tour, including its template ID and a list of locations:

{
    "tourId": "a7b1ac9d-3f64-4bd5-ad84-5cf59a72045b",
    "tourTemplateId": "a7b1ac9d-3f64-4bd5-ad84-5cf59a72045b",
    "locationList": [
        {
            "locationId": "edea824b-5aad-4691-98e1-1493269521b2",
            "name": "Toronto City Hall"
        },
        {
            "locationId": "6dcfc4f0-81c5-4f19-b3df-09464a84213b",
            "name": "Eaton Centre"
        },
        {
            "locationId": "c5e38d48-74c4-438d-8860-d9953afab1fd",
            "name": "Yonge-Dundas Square"
        },
        {
        "locationId": "4b013a3e-60a6-4b99-97b9-5e46c6d0582a",
            "name": "St. Lawrence Market"
        },
        {
            "locationId": "5c744b2b-8f6c-4be1-baf0-409e43a4e06e",
            "name": "Union Station"
        },
        {
            "locationId": "59433eec-63e1-4aef-9322-a077b78f3cd8",
            "name": "CN Tower"
        }
    ]
}