Featured Promos API


The Featured Promos API lets you retrieve a list of Promotions that the Staylist owner has deemed noteworthy in their Staylists portal. By cross-referencing the property with your own database, you’ll be able to create dynamic pages displaying available promotions.


This request requires authentication


Make a GET request to the following endpoint:



Providing some Featured Promos exist, you’ll see something like this:

    "object": "List",
    "data": [
        "id": 4567
        "headline": "20% off",
        "kind": "quick_discount",
        "start_date": "2021-03-01",
        "end_date": "2021-04-28",
        "days_of_week": [6, 7],
        "days_of_week_humanized": "Weekends",
        "rate_type_ids": [7456],
        "bookable_ids": [12578, 12579, 12580, 12581],
        "property_id": 1234,
        "property_name": "The Old Mariner",
        "property_reference": "theoldmariner"
        "id": 4789
        "headline": "£15 off per night",
        "kind": "quick_discount",
        "start_date": "2021-01-01",
        "end_date": "2021-03-31",
        "days_of_week": [5, 6, 7],
        "days_of_week_humanized": "Friday, Saturday and Sunday",
        "rate_type_ids": [3456, 3457],
        "bookable_ids": [2852, 2853, 2854],
        "property_id": 4567,
        "property_name": "The New Galleon",
        "property_reference": "thenewgalleon"
Name Type Description of value
id integer The ID of the Promo
headline string A generated short description of the Promo
kind string One of "quick_discount", "early_bird", "last_minute", "free_night" or "added_extra".
days_of_week array An array of integers representing the days of the week a promo will be applied, where 1 is Monday and 7 is Sunday. Hence [1, 2, 3, 4, 5] would be Monday to Friday. Bookings can straddle promotions, and the best price on each day will apply. So if somebody booked a Friday and Saturday, and a Promo was only available Monday to Friday, then only Friday night's price will be discounted accordingly.
days_of_week_humanized string A convenience method for displaying days of the week. For example, if days_of_week equals [1,2,3,4,5,6,7] then this will return "Every day". If days_of_week equals [1,2,3,4] then this will return "Monday to Thursday".
rate_type_ids array The IDs of the Rate Types this Promo discounts.
bookable_ids array The IDs of the Bookables (Rooms, Apartments, Tent Pitches etc) this Promo discounts.