API Overview

Introduction to the LodgeKit REST API and authentication.

Advanced6 min read6 sections

LodgeKit API

The LodgeKit REST API lets you build custom integrations, automate workflows, and connect third-party tools. All API endpoints are versioned under /api/v1/ and return JSON responses.

Authentication

API requests are authenticated with API keys. Generate a key at Dashboard > Settings > API Keys. Include it in the Authorization header as a Bearer token: Authorization: Bearer your-api-key-here.

API Key Tiers

LodgeKit offers three API key tiers: Free (100 requests/hour), Standard (1,000 requests/hour), and Premium (10,000 requests/hour). Choose the tier that matches your integration volume.

Available Endpoints

The API covers all core resources: rooms (/api/v1/rooms), guests (/api/v1/guests), bookings (/api/v1/bookings), invoices (/api/v1/invoices), and payments (/api/v1/payments). Each supports standard CRUD operations with filtering and pagination.

Interactive Documentation

Full API documentation with request/response examples is available at /api/docs (Swagger UI). You can test endpoints directly from the documentation page using your API key.

Webhooks

Subscribe to real-time events with webhooks. Go to Dashboard > Settings > Webhooks to create a subscription. Choose the events you want to receive (booking created, payment received, invoice sent, etc.) and provide your endpoint URL. LodgeKit sends a POST request with the event payload.

Rate Limiting

API requests are rate-limited based on your key tier. If you exceed the limit, you'll receive a 429 Too Many Requests response with a Retry-After header. Implement exponential backoff in your integration to handle rate limits gracefully.

Was this article helpful?