API Reference

Version 1.1.1

  • New Endpoint:
    • Added /api/sendMessage/:reservationID for sending messages to a reservation, currently only available to partners when approved. Feel free to reach out if you would like access.

Version 1.1.0

  • Add rate limiting: Added rate limiting to the API to manage and control the usage and prevent abuse.
  • Authentication Changes
    • Removed apiKey requirement: Now anyone can use our API with a valid authToken from the user's Settings page.
  • New Endpoints:
    • Added /api/setReservation/:reservationID for updating reservation details, currently only guideBookURL is supported.
    • Added /api/getWebhook endpoint for getting webhook URL.
    • Added /api/getReservation/:reservationID endpoint for retrieving individual reservations.
  • Exposed Fields on the Reservation Schema:
    • lockCode: Lock code sent to smart locks.
    • guideBookURL: Guidebook URL
    • notes: Internal reservation notes.
  • Improved error handling for date validation on /api/getReservations.
  • Exposed Fields on the Listing Schema:
    • notes: Expanded to include structured data for description, house rules, fine print, short description, name, and marketing name, each with language and value properties.
    • neighborhoodOverview: Added to provide information about the listing's neighborhood.
    • about: Added to provide general information about the listing.
    • keyCollection: Added to specify key collection details, including type, check-in method, and additional instructions.
    • policy: Added to include detailed policies for internet, parking, pets, children, and smoking.

Version 1.0.0

  • Initial release with basic endpoints for:
    • Listings
    • Calendar
    • Reservations
    • Webhook