For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LogoLogo
HomeCustomer APIAI Connector (MCP)Revenue Estimator APIIntegration APIRM Partner API
HomeCustomer APIAI Connector (MCP)Revenue Estimator APIIntegration APIRM Partner API
  • API Reference
    • Overview
    • Quick Start
    • Enable the API
    • Pricing Customizations
        • GETGet all listings in an account
        • POSTUpdate one or more listings in an account
        • GETGet a minimal list of listings
        • GETGet a specific listing in an account
        • GETGet listing performance metrics
    • OpenAPI Spec
  • Changelog
    • Changelog
  • Overview
  • Quick Start
  • Enable the API
  • Pricing Customizations
  • Get all listings in an account
  • Update one or more listings in an account
  • Get a minimal list of listings
  • Get a specific listing in an account
  • Get listing performance metrics
  • Map listings under a parent listing
  • Unmap listings from their parent
  • Get all groups in an account
  • Create a new group
  • Get listings assigned to a group or subgroup
  • To fetch a listing's date specific overrides
  • Add/Update a listing's date specific override
  • Delete a listing's date specific override
  • Fetch a group's date specific overrides
  • Add/Update a group's date specific overrides
  • Delete a group's date specific overrides
  • Get prices for listings
  • Refresh a listing
  • Fetch rate plan adjustments for your listings
  • Get neighborhood data for a listing
  • Get Reservations received from your PMS along with rental revenue information.
  • Get bookings report with filters and pagination
  • Fetch available report templates
  • Generate report data
  • Poll report generation status
  • List available nudges
  • Accept a nudge
  • List actions for your listings
  • Read listing-level customizations
  • Create / update listing-level customizations
  • List customization profiles (discovery)
  • Read group-level customizations
  • Create / update group-level customizations
  • Read account-level (pms) customizations
  • Create / update account-level (pms) customizations
  • Get Listing Optimizer summary
  • Get Listing Optimizer report for a listing
  • Get Listing Optimizer ranking for a listing
  • Retrieve activity logs
  • Import newly added listings from PMS
  • Changelog
  • September 1, 2026
  • August 19, 2026
  • July 31, 2026
  • July 30, 2026
  • July 28, 2026
  • July 23, 2026
  • July 20, 2026
  • July 17, 2026
  • July 16, 2026
  • July 14, 2026
  • July 10, 2026
  • July 7, 2026
  • June 30, 2026
  • June 25, 2026
  • June 23, 2026
  • June 11, 2026
  • June 9, 2026
  • June 2, 2026
  • May 26, 2026
  • May 12, 2026
  • March 24, 2026
  • February 3, 2026
  • December 22, 2025
  • December 1, 2025
  • October 13, 2025
  • September 29, 2025
  • July 22, 2025
  • July 1, 2025
  • May 13, 2025
  • April 15, 2025
  • April 10, 2025
  • August 13, 2024
  • July 9, 2024
  • July 4, 2024
  • July 3, 2024
  • June 25, 2024
  • September 27, 2023
  • September 13, 2023
  • June 28, 2023
  • June 20, 2023
  • October 19, 2022
  • July 15, 2022
  • October 29, 2021
  • March 1, 2021
  • January 7, 2021
  • October 19, 2020
  • October 16, 2020
  • November 22, 2019
  • September 17, 2019
  • November 9, 2018
Changelog

Changelog overview

September 13, 2023
September 13, 2023

Added selected metrics from UI dashboard to listings details endpoints

listings
  • GET /v1/listings
  • GET /v1/listings/:listing_id

Listings details will contain additional attributes for metrics depending on selection on UI.

Was this page helpful?
Previous
June 28, 2023
Next
Built with