API Docs

Build on top of Stayer

Integrate properties, bookings, guests, tasks, messages, analytics, and automation events into your own systems.

Authentication

Use scoped API keys for server-side integrations. Keep keys out of browsers and rotate them when team access changes.

Calendar Sync

Connect booking sources, import stays, push direct bookings, and handle availability conflicts with predictable event payloads.

Messaging

Prepare approved templates for WhatsApp, SMS, and email, then send operational updates through a single communication layer.

Webhooks

Subscribe to real-time events like booking.created, task.completed, guest.message.received, and payment.succeeded.

Core API

REST endpoints for rental operations

The API is designed around real short-term rental workflows: availability, guest stays, checkout-driven tasks, operational assignments, and messaging events. Public API access is currently available for approved integration partners.

GET/v1/properties

List properties, units, amenities, check-in details, and operational settings.

GET/v1/bookings

Read bookings, imported stays, direct bookings, blocked dates, and checkout events.

POST/v1/tasks

Create cleaning, maintenance, laundry, inspection, and guest follow-up tasks.

POST/v1/messages

Send approved guest or team messages through configured delivery channels.

GET/v1/analytics/revenue

Fetch revenue, occupancy, conversion, source, and property performance summaries.

POST/v1/webhooks

Register webhook destinations for booking, guest, task, payment, and automation events.

Webhook events

booking.created
booking.updated
guest.message.received
task.created
task.completed
payment.succeeded
automation.suggested
inventory.low_stock

Security model

  • Scoped keys for read, write, messaging, and automation access
  • Webhook signing for event authenticity
  • Role-aware permissions for owner, manager, staff, and integration users
  • Approval requirements for sensitive or business-critical actions

Need API access?

API access is available for approved implementation partners, property management systems, and larger operators.

Contact Stayer