Read listing-level customizations | PriceLabs

curl -G https://api.pricelabs.co/v1/customizations/listing \
     -H "X-API-Key: {{API_KEY}}" \
     -d listing_id=12345 \
     -d pms_name=airbnb \
     --data-urlencode customizations=last_minute_prices,demand_factor \
     -d toggled_on=false

{
  "customizations": {
    "seasonality": {
      "seasonality_customization_on": true,
      "seasonality_type": "recommended"
    },
    "last_minute_prices": {
      "last_min_factor_on": true,
      "last_min_factor_type": "linear",
      "last_min_factor_value": -15,
      "last_min_factor_dfd": 14
    },
    "custom_seasonal_profile": {
      "custom_seasonal_profile_on": true,
      "custom_seasonal_profile": {
        "price_type": "percentage",
        "seasons": [
          {
            "season_name": "Summer",
            "start_month": "5",
            "start_day": "15",
            "end_month": "8",
            "end_day": "31",
            "lowest_price": 10,
            "base_price": 25,
            "highest_price": 60,
            "minstay_profile_id": 1234,
            "pricing_profile_id": null,
            "checkincheckout_profile_id": null
          }
        ]
      }
    }
  }
}

Returns the listing’s OWN-level customization values (write-body-shaped). By default only toggled-ON customizations are returned; pass toggled_on=false to also include toggled-off ones with their full data packs. ?customizations= filters the set. 404 only if the listing itself is not found; a listing with no customizations set returns 200 with an empty customizations map.

Returns the listing's OWN-level customization values (write-body-shaped). By default only toggled-ON customizations are returned; pass `toggled_on=false` to also include toggled-off ones with their full data packs. `?customizations=` filters the set. 404 only if the listing itself is not found; a listing with no customizations set returns 200 with an empty `customizations` map.

Query parameters

listing_idstringRequired

Listing id (listing-level).

pms_namestringRequired

PMS name (paired with listing_id).

customizationsstringOptional

Comma-separated spec keys to return; omit to return all supported.

toggled_onbooleanOptionalDefaults to true

When true (default), only customizations whose toggle is ON are returned. Pass false to also include toggled-off customizations with their full data packs.

Response

Customizations retrieved

customizationsobjectOptional

Map of customization name → its settings. Include any one or more of the customizations below in a single request. Unknown or unsupported customization names are rejected.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

Headers

Query parameters

Response

Errors