Skip to content
Configuration
/
Get configuration

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

Get configuration

Request

Fetches essential configuration data for the API, including supported languages, currencies, locations, timezones, and the base URL for images.

Security
Authorization
curl -i -X GET \
  https://docs.bemyguest.com.sg/_mock/openapi/v2/config \
  -H 'X-Authorization: YOUR_API_KEY_HERE'

Responses

Successful Configuration Response

Bodyapplication/json
dataobject(Configuration Object)required

The main payload of the response.

data.​nowstring

Time

data.​versionintegerint32

API version

data.​serverUrlstring

Api Server URL

data.​photosUrlstring

Photos URL

data.​activitiesSortingArray of strings

Activities default sorting

data.​userobject(User)

User details (booking contact)

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

Languages object

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

Currencies object

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

Product type

data.​types.​dataArray of objects(ActivityType)required

Data object

data.​types.​data[].​namestringrequired

Type name

data.​types.​data[].​uuidstringrequired

UUID of activity type

data.​categoriesobject(Categories)

Categories object

data.​categories.​dataobject(Category)required

Data object

data.​categories.​data.​Namestringrequired

name of category

data.​categories.​data.​uuidstringrequired

UUID of category

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

Sub categories

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

Subcategory name

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

UUID of subcategory

data.​locationsobject(Location)

Locations object

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

Booking Options input types

data.​optionInputTypes[].​methodstringrequired
data.​optionInputTypes[].​relstringrequired
data.​optionInputTypes[].​hrefstringrequired
data.​linksArray of objects(Link)
data.​links[].​methodstringrequired
data.​links[].​relstringrequired
data.​links[].​hrefstringrequired
timestampstring(date-time)required

The timestamp when the response was generated.

Response
application/json
{
  "data": {
    "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": [ … ],
    "user": { … },
    "languages": { … },
    "currencies": { … },
    "types": { … },
    "categories": { … },
    "locations": { … },
    "optionInputTypes": [ … ],
    "links": [ … ]
  },
  "timestamp": "2019-08-24T14:15:22Z"
}

Requests

Schemas that define requests.

Responses

Schemas that define API responses.

webhooks

Webhooks