Skip to content
Schemas
/
Countries

BeMyGuest API v2.0 (2.1)

The BeMyGuest API is the industry benchmark preferred by online travel agents, designed solely for Asia's attractions, tours and activities. This comprehensive API provides real-time access to a vast inventory of travel products.

Key Features:

  • Product Discovery: Search and retrieve detailed information for a wide range of travel products, including attractions, tours, and activities.
  • Real-Time Availability and Pricing: Check live availability and get up-to-date pricing for specific product types and dates.
  • End-to-End Booking Management: Create, confirm, and cancel bookings seamlessly.
  • Voucher Retrieval: Access and download booking vouchers directly through the API.
  • Configuration: Fetch essential configuration data such as supported languages, currencies, and locations to customize your integration.
Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://www.bemyguest.com.sg/contact-us

BeMyGuest API Support

support@bemyguest.com.sg

Languages
Servers
Mock server

https://docs.bemyguest.com.sg/_mock/openapi/

Api Demo Server

https://api.demo.bemyguest.com.sg/

Api Production Server

https://api.bemyguest.com.sg/

Products

Endpoints for searching and retrieving product details.

Operations

Product-Types

Endpoints for retrieving product type information, pricing, and availability.

Operations

Bookings

Endpoints for creating and managing bookings.

Operations

Configuration

Endpoints for retrieving API configuration data.

Operations

Requests

Schemas that define requests.

Responses

Schemas that define API responses.

webhooks

Webhooks

Configuration Object

nowstring

Time

versionintegerint32

API version

serverUrlstring

Api Server URL

photosUrlstring

Photos URL

activitiesSortingArray of strings

Activities default sorting

userobject(User)

User details (booking contact)

user.​namestringrequired
user.​emailstringrequired
user.​uuidstringrequired
user.​continueUrlstringrequired
user.​notifyUrlstringrequired
user.​defaultPaginationintegerint32required
user.​defaultSortBystringrequired
user.​defaultCurrencyUuidstringrequired
user.​defaultCurrencyCodestringrequired
user.​defaultLanguageUuidstringrequired
user.​defaultLanguageCodestringrequired
user.​walletBalancenumberrequired
user.​walletBlockedBalanceintegerint32required
user.​walletAvailableBalancenumberrequired
user.​walletAlertValueintegerint32required
languagesobject(Languages)

Languages object

languages.​dataArray of objects(Language)required
languages.​data[].​namestringrequired
languages.​data[].​codestring
languages.​data[].​uuidstringrequired
currenciesobject(Currencies)

Currencies object

currencies.​dataArray of objects(Currency)required
currencies.​data[].​codestringrequired
currencies.​data[].​symbolstringrequired
currencies.​data[].​uuidstringrequired
typesobject(Activity Types)

Product type

types.​dataArray of objects(ActivityType)required

Data object

types.​data[].​namestringrequired

Type name

types.​data[].​uuidstringrequired

UUID of activity type

categoriesobject(Categories)

Categories object

categories.​dataobject(Category)required

Data object

categories.​data.​Namestringrequired

name of category

categories.​data.​uuidstringrequired

UUID of category

categories.​data.​childrenArray of objects(SubCategory)

Sub categories

categories.​data.​children[].​namestringrequired

Subcategory name

categories.​data.​children[].​uuidstringrequired

UUID of subcategory

locationsobject(Location)

Locations object

locations.​citystringrequired
locations.​cityUuidstringrequired
locations.​statestringrequired
locations.​stateUuidstringrequired
locations.​countrystringrequired
locations.​countryUuidstringrequired
optionInputTypesArray of objects(Link)

Booking Options input types

optionInputTypes[].​methodstringrequired
optionInputTypes[].​relstringrequired
optionInputTypes[].​hrefstringrequired
linksArray of objects(Link)
links[].​methodstringrequired
links[].​relstringrequired
links[].​hrefstringrequired
{
  "now": "2025-02-20T03:49:13.130670Z",
  "version": 2,
  "serverUrl": "http://api.bemyguest.com.sg.local",
  "photosUrl": "https://s3.amazonaws.com/playground.bemyguest.com.sg",
  "activitiesSorting": [
    "date",
    "-date",
    "price",
    "-price",
    "distance",
    "-distance"
  ],
  "user": {
    "name": "BeMyGuest",
    "email": "example@bemyguest.com.sg",
    "uuid": "30d23074-959f-4179-84c7-4787349828a1",
    "continueUrl": "",
    "notifyUrl": "",
    "defaultPagination": 50,
    "defaultSortBy": "date",
    "defaultCurrencyUuid": "null",
    "defaultCurrencyCode": "null",
    "defaultLanguageUuid": "790395c0-23b6-5dd9-8a6b-ca61b95dcfd4",
    "defaultLanguageCode": "EN",
    "walletBalance": 18941.98,
    "walletBlockedBalance": -10206,
    "walletAvailableBalance": 8735.98,
    "walletAlertValue": 0
  },
  "languages": {
    "data": [ … ]
  },
  "currencies": {
    "data": [ … ]
  },
  "types": {
    "data": [ … ]
  },
  "categories": {
    "data": { … }
  },
  "locations": {
    "city": "Sentosa",
    "cityUuid": "29ad1bd7-2000-5321-aff8-f71a6464142b",
    "state": "Sentosa",
    "stateUuid": "ab7d9ac9-036d-11e5-a2a9-d07e352b4840",
    "country": "Singapore",
    "countryUuid": "885e90a3-a83d-56d3-b5e8-040b4017c825"
  },
  "optionInputTypes": [
    { … }
  ],
  "links": [
    { … }
  ]
}

Countries

dataArray of objects(Country)required

Data object

data[].​namestringrequired
data[].​codestringrequired
data[].​uuidstringrequired
data[].​statesobject(States)

State details

data[].​states.​dataArray of objects(State)required
data[].​states.​data[].​namestringrequired
data[].​states.​data[].​uuidstringrequired
data[].​states.​data[].​citiesobject(Cities)required
data[].​states.​data[].​cities.​dataArray of objects(City)
{
  "data": [
    { … }
  ]
}

Country

namestringrequired
codestringrequired
uuidstringrequired
statesobject(States)

State details

states.​dataArray of objects(State)required
states.​data[].​namestringrequired
states.​data[].​uuidstringrequired
states.​data[].​citiesobject(Cities)required
states.​data[].​cities.​dataArray of objects(City)
states.​data[].​cities.​data[].​namestringrequired

City name

states.​data[].​cities.​data[].​uuidstringrequired

City UUID

{
  "name": "Angola",
  "code": "AO",
  "uuid": "78317982-9806-45c9-bdfa-7faea34d4834",
  "states": {
    "data": [ … ]
  }
}