v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Addons

Retrieve property add-ons

Fetches list of Add-ons with basic information for a specific property

get/addons/v1/addons

Query parameters

limitinteger

The maximum number of items to return in the response. Default is 100.

offsetinteger

The number of items to skip before starting to collect the result set. Used for pagination.

This parameter should be formatted as a list of strings separated by ;

{
  "filters": {
    "and": [
      {
        "field": "checkin_date",
        "value": "2023-10-19T00:00:00"
      }
    ],
    "or": [
      {
        "field": "checkin_date",
        "value": "2023-10-19T00:00:00"
      }
    ]
  }
}

Headers

x-property-idstring required

Example:1,2,3

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

Accept-Languagestring

The preferred language(s) for localized strings (e.g., en-US)

Response

Successful response

offsetinteger required

Number of results to skip

limitinteger required

Maximum number of results to return

Example response

{
  "limit": 100,
  "data": [
    {
      "id": "98765",
      "name": "Breakfast",
      "description": "A basic continental breakfast...",
      "productId": "12345",
      "price": {
        "amount": "12439",
        "currencyCode": "USD"
      }
    }
  ]
}