API Overview

Introduction to the LodgeKit REST API and authentication.

Advanced6 min read5 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.

Available Endpoints

The API covers all core resources: units, people records, bookings, invoices, and 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.

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.

Always implement exponential backoff in your integration. Start with a 1-second delay and double it on each retry.

Was this article helpful?

LodgeKit — Accommodation Management Software for Property Managers