Venues

Venues are popular attractions or landmarks.

Search venues

Response only contains venues with a status of ACTIVE and events_count value greater than zero.

Request
query Parameters
country_in
Array of integers

Filter venues by country. Response contains venues which are located in at least one of the specified countries. Parameter expects a comma-separated list of country IDs.

limit
integer [ 1 .. 100 ]

Limit the maximum number of venues to include in the response.

offset
integer >= 0
Default: 0

Exclude the first N results from the response, where N is the specified integer value.

page
integer >= 1

Get the page number of venues, based on the limit parameter.

sort_by
string

Sort results by a specified property. Sorts from lowest to highest by default. Add - to the beginning to sort from highest to lowest.

Enum: relevance -relevance
header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

Venues

400

Bad request: there are errors in the request

401

Unauthorized: token is not valid

404

Not found: no venue matches the search criteria

503

Service unavailable

get/venues
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/venues?country_in=1&limit=1&offset=0&page=1&sort_by=relevance' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Get venue

Request
path Parameters
venueId
required
integer

Numeric ID for venue

header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

Venue

401

Unauthorized: token is not valid

404

Resource not found

503

Service unavailable

get/venues/{venueId}
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/venues/{venueId}' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{
  • "abstract": "string",
  • "address": "string",
  • "city": {
    },
  • "country": {
    },
  • "cover_image_url": "http://example.com",
  • "description": "string",
  • "description_html": "string",
  • "events_count": 0,
  • "id": 0,
  • "latitude": 0,
  • "longitude": 0,
  • "meta_description": "string",
  • "meta_title": "string",
  • "name": "string",
  • "headline": "string",
  • "relevance": 0,
  • "reviews_avg": 0,
  • "reviews_number": 0,
  • "show_calendar": true,
  • "show_flavours_filter": true,
  • "slug": "string",
  • "status": "ACTIVE",
  • "tips": [ ],
  • "verticals": []
}

Search activities in venue

Response only contains activities with a status of ONLINE.

Request
path Parameters
venueId
required
integer

Numeric ID for venue

query Parameters
category
integer (Category ID) >= 1

Filter results by category.

city
integer (City ID) >= 1

The numeric ID of the city.

flavour
integer >= 1

Filter results by flavour. Parameter expects a single flavour ID.

limit
integer <= 100
Default: 100

Limit the maximum number of results to include in the response.

offset
integer >= 0
Default: 0

Exclude the first N results from the response, where N is the specified integer value.

sort_by
string
Default: city-relevance

Sort results by specific properties. Most values sort activities from highest to lowest values. However, when sorting by price, the results appear from lowest to highest values.

Enum: city-relevance external-relevance price rating relevance-city relevance-external relevance
vertical
integer (Vertical ID) >= 1
Deprecated

The numeric ID of the vertical.

header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Currency
string (Currency code)
Default: USD

A valid currency code from the /currencies endpoint. Default value may vary depending on the X-Musement-Market header value.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

Activities in venue

302

Found: when the limit parameter is greater than the maximum, the endpoint is redirected with limit={maximum}

401

Unauthorized: token is not valid

404

Resource not found

503

Service unavailable

get/venues/{venueId}/activities
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/venues/{venueId}/activities?category=1&city=1&flavour=1&limit=100&offset=0&sort_by=city-relevance&vertical=1' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Currency: USD' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Search comments about activities in venue

Comments are an older form of review submitted directly to the Musement platform.

Request
path Parameters
venueId
required
integer

Numeric ID for venue

query Parameters
include_empty
string
Default: YES

Include comments in the response with an empty body property.

Enum: NO YES
limit
integer <= 100
Default: 10

Limit the maximum number of results to include in the response.

locale
string (Language code)

Filter results by the locale property.

offset
integer >= 0
Default: 0

Exclude the first N results from the response, where N is the specified integer value.

rating_in
string^\d+(,\d+)*$

Filter comments by their rating property. Providing a single integer returns comments greater than or equal to the value. Providing two integers separated by a comma returns comments with a rating within the specified range.

sort_by
string

Sort comments by one of the following choices:

  • DATE: From least recent sent_at value to most recent.
  • -DATE: From most recent sent_at value to least recent
  • RATING: From lowest rating to highest.
  • -RATING: From highest rating to lowest.
Enum: -DATE -RATING DATE RATING
header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

Comments about activities in venue

400

Bad request: there are errors in the request

401

Unauthorized: token is not valid

503

Service unavailable

get/venues/{venueId}/comments
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/venues/{venueId}/comments?include_empty=NO&limit=10&locale=string&offset=0&rating_in=string&sort_by=-DATE' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[]

Get flavours for activities in venue

Request
path Parameters
venueId
required
integer

Numeric ID for venue

header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
Responses
200

Flavours for activities in venue

401

Unauthorized: token is not valid

404

Resource not found

503

Service unavailable

get/venues/{venueId}/flavours
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/venues/{venueId}/flavours' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]