Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Amenities

Get amenity catalog

Returns the complete list of amenities available for the specified scope (property or room) with their translated names and category codes.

get/amenities/v1/catalogs/amenities

Query parameters

scope'property' | 'room' required
Example:property

The scope of amenities to retrieve

Headers

x-property-idstring required
Example:1,2,3

A numeric, comma-separated string representing the property IDs, sent in the header.

Accept-Languagestring
Example:es-ES, en;q=0.8

RFC 5646 language preferences used for negotiation (e.g. es-ES, en;q=0.8).

Response

A list of amenities in the catalog for the requested scope.

Example response

{
  "amenities": [
    {
      "code": "wifi",
      "name": "Wi-fi",
      "categoryCode": "technology",
      "isTop": true
    }
  ]
}