API Reference

Changelog

Version 1.3.0

  • New User Endpoint:

    • Added /api/getUser endpoint that returns current authenticated user information, including userID, email, firstName, and lastName. Empty strings are returned for names when not set.

  • New Reviews Endpoint:

    • Added /api/getReviews/{listingID} endpoint that returns reviews for listings with Airbnb channels connected, including review count, comments, ratings, and reviewer information.

  • Enhanced Listing Endpoints:

    • Enhanced /api/getListings endpoint with optional startDate and endDate query parameters for availability filtering. When both dates are provided, it only returns listings that are available for the specified date range, checking for blocked dates, minimum night requirements, and pricing availability.

  • New Reservation Management Endpoints:

    • Added /api/getQuote/{listingID} endpoint for calculating pricing quotes with availability checking, including base pricing, fees, taxes, and detailed line item breakdowns. Returns 409 status with unavailable dates when conflicts exist.
    • Added /api/createReservation endpoint for programmatically creating internal reservations with full guest details, pricing, and status management.

  • Enhanced Listing Schema:

    • Added region field to provide state/region information
    • Added images array containing listing image URLs
    • Added minNights for minimum booking requirements
    • Added basePrice for base nightly rate
    • Added maxGuests for maximum occupancy
    • Added attributesWithQuantity array for property amenities with quantities
    • Added nearbyAmenities array for nearby attractions with distances
    • Added propertyType field with standardized property types
    • Added bedroomConfiguration object with detailed bedroom and bed information
    • Added space field for property area/size measurement
    • Added spaceUnit field for space measurement units (SQ_M, SQ_FT)

  • New Schema Definitions:

    • Added AmenityEnum with 96+ standardized amenity values across booking platforms
    • Added NearbyAmenityEnum for nearby amenities (Airport, Ferry, Shopping, Railway, Beach)
    • Added PropertyTypeEnum with 43+ property types (apartment, villa, castle, etc.)
    • Added BedTypeEnum with bed types (king_bed, queen_bed, sofa_bed, etc.)
    • Added GetReviews and Review schemas for review functionality
    • Added GetQuoteRequest and GetQuote schemas for pricing quote functionality
    • Added CreateReservation schema for reservation creation with comprehensive guest and pricing details

  • Schema Updates:

    • Updated User, Listing, Reservation, and Price schemas to document new userID fields

Version 1.2.0

  • Enhanced Webhook Documentation: Added better documentation for
    webhook payloads and implementation guidelines.

  • New Reservation Field:

    • posts: Added message/communication thread data to reservation objects. This includes all messages between hosts and guests, with timestamps, attachments, and sender information.

  • New Webhook Type:

  • Message Webhooks: Real-time notifications when new messages or attachments are added to reservation threads. The webhook payload includes message content, sender information, and attachments.

  • Webhook Improvements:

  • Added 30-second timeout for all webhook requests

  • Enhanced webhook payload schemas with detailed examples

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