Last updated:
05-Aug-2026
Recent changes:
add other description files
Geo Hierarchy API
The Geo Hierarchy API provides TUI accommodation details across the world. Consumers can retrieve accommodations matching the supplied geographic search criteria through the TUI API gateway.
API Endpoints
| Environment | URL |
|---|---|
| LIVE | https://prod.api.tui/geoHierarchy/geoHierarchy_v1 |
API Methods
Method: GET
{
"geoHierarchyRequest": {
"request": [{
"countryName": "India"
}]
}
}HTTP Headers
| HeaderName | Value | Inbound/Outbound | Description |
|---|---|---|---|
| x-api-key | <your-api-key> | Inbound | Your unique key authorisation to access the geoHierarchy API. |
| Accept | application/json;geoHierarchy;version=1.0 / |
Inbound / Outbound | Version of geoHierarchy API invoked. If specified as / then the latest geoHierarchy API version will be called. |
Search Request Parameters
Search parameters should be submitted in the same order and are case sensitive.
| Field | Description | Format | Example |
|---|---|---|---|
| continentName | Search can be made at continent level | String | Africa |
| countryCode | IATA Standard country code | String | IND, CPV, etc. |
| countryName | Country name | String | India, Cape Verde |
| regionCode | TUI Specific 6 digit region code | String | 000154 |
| regionName | Region Name | String | Algarve |
| resortCode | TUI Specific 6 digit resort code | String | 000172 |
| resortName | Resort Name | String | Albufeira |
| destinationCode | TUI Specific 6 digit destination code | String | 000172 |
| destinationName | Destination or Resort Name | String | Albufeira |
| accomId | TUI Specific accommodation ID | String | 000091 |
| accomName | TUI Accommodation Name | String | Aparthotel Brisa Sol |
Note: None of the request parameters are mandatory. If no input is specified, the API returns all TUI accommodations irrespective of geographic search criteria. More than one search criterion can be provided in the request.
Response Parameters
Every response includes a standard HTTP status code. A successful request returns 200 OK; failed requests return an appropriate 4xx or 5xx code together with any available error details.
| Field | Description | Format | Mandatory | Example | ||
|---|---|---|---|---|---|---|
| continentName | Name of the continent to which the accommodation belongs to. | String | Yes | Africa | ||
| countryCode | Standard IATA country code to which the accommodation belongs to. | String | Yes | CPV | ||
| countryName | Name of the country to which the accommodation belongs to. | String | Yes | Cape Verde | ||
| regionCode | TUI Specific 6 digit region code. | String | No | 000154 | ||
| regionName | TUI Specific region name. | String | No | Algarve | ||
| resortCode | TUI Specific 6 digit resort code. | String | No | 000172 | ||
| resortName | TUI Specific resort name. | String | No | Albufeira | ||
| destinationCode | TUI Specific 6 digit resort or destination code. | String | No | 000172 | ||
| destinationName | TUI Specific resort or destination name. | String | No | Albufeira | ||
| accommodation | accomId | TUI Specific 6 digit unique accommodation id. | String | Yes | 000091 | |
| accomName | TUI's Accommodation name. | String | Yes | Aparthotel Brisa Sol | ||
| longitude | Longitude of the accommodation. | String | No | 37.0916 | ||
| latitude | Latitude of the accommodation. | String | No | -8.2401 | ||
| brand | tuiUK | Indicates whether the accommodation belongs to TUI UK brand or not. | Boolean | No | TRUE | |
| tuiIreland | Indicates whether the accommodation belongs to TUI Ireland brand or not. | Boolean | No | TRUE | ||
| firstChoice | Indicates whether the accommodation belongs to First Choice brand or not. | Boolean | No | False | ||
| address | line1 | Unstructured postal address of TUI accommodation | ||||
| line2 | Unstructured postal address of TUI accommodation | |||||
| line3 | Unstructured postal address of TUI accommodation | |||||
| line4 | Unstructured postal address of TUI accommodation | |||||
| postalCode | Accommodation Postal Code | |||||
| phone | Accommodation Contact Point (Landline or Mobile) | +30 (0)2845559890 | ||||
| fax | Fax | |||||
| Email Address | ||||||
| longitude | Longitude of the accommodation. | String | No | 37.0916 | ||
| latitude | Latitude of the accommodation. | String | No | -8.2401 |
Support
For support, contact TIBCO Operations Support.
