Lists

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

Get list types

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. For more info, check out our guide.
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 For more info, check out our guide.

Responses

200

List types

default

Error

Request samples

curl
C#
Node.js

Response samples

200
default

application/json

[{"id": 3,
"name": "Musement list"
}
]

Search lists

get/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. For more info, check out our guide.
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. For more info, check out our guide.
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 For more info, check out our guide.

Responses

200

Lists

404

Not found: no list matches request parameters

default

Error

Request samples

curl
C#
Node.js

Response samples

200
404
default

application/json

[{"id": 244,
"subtitle": "Top experiences in New York",
"title": "Top experiences",
"description": "Pressed for time? Or maybe you just want to know what you can't miss straight up. This list was made for you. It rounds up the best experiences of the city, from fabulous local dining to landmark attractions.",
"seo_title": "Top experiences in New York",
"seo_description": "Pressed for time? Or maybe you just want to know what you can't miss straight up. This list was made for you. It rounds up the best experiences of the city, from fabulous local dining to attractions.",
"temporary": false,
"url": "https://.sbox.musement.com/us/new-york/top-experiences-l/",
"authors": [{"firstname": "John",
"lastname": "Doe",
"avatar": "https://www.gravatar.com/avatar/e94c7fb0820eee18369683757700f3e6?s=120&d=identicon&r=g"
}
],
"list_type": {"id": 3,
"name": "Musement list"
},
"items": [{"event": {"title": "Empire State Building Observatory standard or skip-the-line tickets",
"uuid": "0f660706-2046-11e7-9cc9-06a7e332783f"
},
"public_type": "musement",
"title": "Empire State Building Observatory tickets"
}
],
"items_count": {"generic": 0,
"thirdparty": 1,
"musement": 9
},
"city": {"id": 55,
"name": "New York",
"cover_image_url": "https://images-sandbox.musement.com/cover/0002/42/view-on-manhattan-at-night-new-york-usa-jpg_header-141511.jpeg",
"url": "https://.sbox.musement.com/us/new-york/",
"time_zone": "America/New_York"
},
"cover_image_url": "https://images-sandbox.musement.com/default/0001/59/thumb_58199_default_header.jpeg?w=750&h=500",
"verticals": [{ }
],
"category": { }
}
]

Get list

get/lists/{listId}

Returns a 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. For more info, check out our guide.
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. For more info, check out our guide.
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 For more info, check out our guide.

Responses

200

List

404

Resource not found

default

Error

Request samples

curl
C#
Node.js

Response samples

200
404
default

application/json

{"id": 244,
"subtitle": "Top experiences in New York",
"title": "Top experiences",
"description": "Pressed for time? Or maybe you just want to know what you can't miss straight up. This list was made for you. It rounds up the best experiences of the city, from fabulous local dining to landmark attractions.",
"seo_title": "Top experiences in New York",
"seo_description": "Pressed for time? Or maybe you just want to know what you can't miss straight up. This list was made for you. It rounds up the best experiences of the city, from fabulous local dining to attractions.",
"temporary": false,
"url": "https://.sbox.musement.com/us/new-york/top-experiences-l/",
"authors": [{"firstname": "John",
"lastname": "Doe",
"avatar": "https://www.gravatar.com/avatar/e94c7fb0820eee18369683757700f3e6?s=120&d=identicon&r=g"
}
],
"list_type": {"id": 3,
"name": "Musement list"
},
"items": [{"event": {"title": "Empire State Building Observatory standard or skip-the-line tickets",
"uuid": "0f660706-2046-11e7-9cc9-06a7e332783f"
},
"public_type": "musement",
"title": "Empire State Building Observatory tickets"
}
],
"items_count": {"generic": 0,
"thirdparty": 1,
"musement": 9
},
"city": {"id": 55,
"name": "New York",
"cover_image_url": "https://images-sandbox.musement.com/cover/0002/42/view-on-manhattan-at-night-new-york-usa-jpg_header-141511.jpeg",
"url": "https://.sbox.musement.com/us/new-york/",
"time_zone": "America/New_York"
},
"cover_image_url": "https://images-sandbox.musement.com/default/0001/59/thumb_58199_default_header.jpeg?w=750&h=500",
"verticals": [null
],
"category": { }
}

Get pages for list

get/lists/{listId}/regions

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. For more info, check out our guide.
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 For more info, check out our guide.

Responses

200

Pages for list

404

Resource not found

default

Error

Request samples

curl
C#
Node.js

Response samples

200
404
default

application/json

[{"code": "us",
"url": "https://.sbox.musement.com/us/new-york/top-experiences-l/"
}
]