Public API & Integrations
Connect SwiftGuest to your stack with a full REST API, outbound webhooks, and native integrations for accounting, payments, and access control.
OpenAPI 3.0
Full spec with interactive examples
Scoped Keys
Read-only, read-write, or admin per resource
Rate Limiting
1000 req/min default, configurable
Webhooks
8 event types with HMAC-SHA256 signatures
API Resources
Platform
Developer-First Integration Layer
REST API
Full-featured REST API covering reservations, guests, rooms, rates, folios, payments, and housekeeping. JSON responses with pagination, filtering, and OpenAPI specification.
API Key Authentication
Generate scoped API keys with granular permissions per resource. Keys can be restricted by IP address, rate limited, and revoked instantly from the dashboard.
Outbound Webhooks
Configure webhooks for reservation changes, guest check-in/out, payment events, and housekeeping updates. Each webhook includes retry logic and delivery status tracking.
Accounting & Lock Integrations
Native integrations with QuickBooks and Xero for automatic revenue posting. Stripe Connect for payment splits. Smart lock integrations for door access key generation.
Getting Started
Integrate in Minutes
Generate Key
Create a scoped API key from Settings. Choose permissions and IP restrictions.
Read the Spec
OpenAPI 3.0 docs with interactive examples and request/response schemas.
Build & Ship
Make authenticated requests. Set up webhooks for real-time event streaming.
Frequently asked questions
What does the API cover?
The SwiftGuest API provides endpoints for reservations, guests, rooms, room types, rate plans, folios, payments, housekeeping, maintenance, and properties. Full OpenAPI 3.0 documentation is available with interactive examples.
How does API authentication work?
You generate API keys from the Settings page. Each key has scoped permissions (read-only, read-write, or admin) and can be restricted to specific IP addresses. Keys are transmitted via the Authorization header.
What webhook events are available?
Webhook events include reservation.created, reservation.updated, reservation.cancelled, guest.checkin, guest.checkout, payment.received, payment.refunded, and housekeeping.status_changed. Each event payload includes the full resource data.
Which accounting systems integrate natively?
SwiftGuest integrates with QuickBooks Online and Xero. Revenue, payments, and invoices sync automatically to your chart of accounts. You map SwiftGuest revenue centers to your accounting categories during setup.
Do you support smart lock systems?
Yes. SwiftGuest integrates with smart lock providers to generate digital door keys at check-in. Keys are sent to guests via email or the guest portal and expire automatically at checkout.