Categories

Categories group activities based on similar characteristics.

Search categories

Request
query Parameters
filtering_aware
boolean

Filter results to categories which can or cannot be used as filters for special landing pages.

Enum: true false
level
integer >= 0
Default: 0

Filter results to categories with the same level property value. A value of zero returns all categories.

limit
integer <= 100
Default: 10

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.

parent_id
integer (Category ID)

Filter results to categories whose direct parent category matches the requested id.

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-Market
string (Musement market)
Default: us

Musement markets contain a modified catalog of activities and prices. Partners are expected to use their assigned market code to view their customized catalog.

An invalid X-Musement-Market value will return a 400 status code response.

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

Categories

default

Error

get/categories
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/categories?filtering_aware=true&level=0&limit=10&offset=0&parent_id=0' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[]

Get category

Request
path Parameters
categoryId
required
integer (Category ID) >= 1

The numeric ID of the category.

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-Market
string (Musement market)
Default: us

Musement markets contain a modified catalog of activities and prices. Partners are expected to use their assigned market code to view their customized catalog.

An invalid X-Musement-Market value will return a 400 status code response.

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

Category

404

Resource not found

default

Error

get/categories/{categoryId}
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/categories/{categoryId}' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{}

Search activities in category

Response only contains activities with a status of ONLINE.

Request
path Parameters
categoryId
required
integer (Category ID) >= 1

The numeric ID of the category.

query Parameters
city
integer (City ID) >= 1

The numeric ID of the city.

offset
integer >= 0
Default: 0

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

limit
number <= 100
Default: 100

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

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
venue
integer (Venue ID) >= 1

The numeric ID of the venue.

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-Market
string (Musement market)
Default: us

Musement markets contain a modified catalog of activities and prices. Partners are expected to use their assigned market code to view their customized catalog.

An invalid X-Musement-Market value will return a 400 status code response.

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 category

302

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

404

Resource not found

default

Error

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

Get category with city

This endpoint returns a category along with the requested city in the city property, useful when constructing a page for a category in a city.

Request
path Parameters
categoryId
required
integer (Category ID) >= 1

The numeric ID of the category.

cityId
required
integer (City ID) >= 1

The numeric ID of the city.

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-Market
string (Musement market)
Default: us

Musement markets contain a modified catalog of activities and prices. Partners are expected to use their assigned market code to view their customized catalog.

An invalid X-Musement-Market value will return a 400 status code response.

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

Category with city

404

Resource not found

default

Error

get/categories/{categoryId}/cities/{cityId}
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/categories/{categoryId}/cities/{cityId}' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{}

Get category tree

Get all categories in their hierarchical tree structure. The response itself is a "fake" category whose children property contains all the real categories.

Request
header Parameters
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

Category tree

default

Error

get/categories-tree
Request samples
curl -i -X GET \
  https://sandbox.musement.com/api/v3/categories-tree \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
{}