Lists

Lists are collections of Musement activities and third-party destinations grouped together based on editorial themes.

Get list types

Every list is assigned a list type to indicate its general purpose. This endpoint returns all list types available in the API.

Request
query Parameters
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.

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

List types

default

Error

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

Search lists

Response only contains published lists with one or more available items.

Request
query Parameters
category_in
Array of integers (Category ID)

Filter results to those which use at least one of the specified categories.

city_in
Array of integers (City ID)

Filter results to those which are connected to at least one of the specified cities.

country_in
Array of integers (Country ID)

Filter results to those which are connected to at least one of the specified countries.

exclude_not_tagged
string

Exclude results which have no tags.

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

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

listtags
Array of strings (List tag)

Filter results to those which best match the specified list tags.

listtype
Array of integers (List type ID)

Filter results to those which match any of the specified list types.

offset
integer >= 0
Default: 0

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

temporary
string

Filter results based on their temporary property:

  • NO: return results with a temporary value of false.
  • YES: return results with a temporary value of true.
Enum: NO YES
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-Device-Type
string

This header affects the results of the /lists and /cities/{cityId}/lists endpoints. The response will contain lists which are considered better for customers using the specified device type.

Enum: DESKTOP MOBILE
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

Lists

404

Not found: no list matches request parameters

default

Error

get/lists
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/lists?category_in=0&city_in=0&country_in=0&exclude_not_tagged=NO&limit=10&listtags=string&listtype=0&offset=0&temporary=NO&vertical=1' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Device-Type: DESKTOP' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[]

Get list

Request
path Parameters
listId
required
integer (List ID) >= 1
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

List

404

Resource not found

default

Error

get/lists/{listId}
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/lists/{listId}' \
  -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 pages for list

Get all available musement.com pages for the specified list.

Request
path Parameters
listId
required
integer (List ID) >= 1
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

Pages for list

404

Resource not found

default

Error

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