🧩API Documentation
Learn how to use our APIs, create credentials, authenticate requests, and build custom booking and guest workflows across bookings, guests, and availability.
Everything you need to connect external systems to Hostel Mate—create bookings, sync guests, fetch availability, and more.
Quick Start
Generate an API key: API Access
Add the key to your request headers: Authentication
Call your first endpoint — for example Bookings Create
Core Guides
Authentication: required headers and rate limits — read more
Availability: check which rooms a guest can book for a stay, and for how much — read more
Rates calendar: read nightly prices, closed dates, beds for sale and stay rules, and change prices — read more
Sync only the bookings that changed — read more
Booking Engine: build your own booking flow (check availability, then create the booking) — read more
Booking operations: Bookings List, Booking Detail, Bookings Create, Bookings Update, Booking Logs, and Booking Delete
Payments endpoint: Payments
Guests endpoints: Guests GET and Guests Update
Webhooks: real-time event notifications — read more
Best Practices
Store API keys server-side only; rotate them after staff changes
Always include
Idempotency-KeyonPOSTandPATCHrequests — it is required, not optional; missing it returns400Respect the 120 requests per minute limit (per API key) and add exponential backoff on 429 errors
Log request IDs from responses to speed up support investigations
Need Help?
Send request IDs, timestamps, and payload summaries to contact@hostelmate.co when opening a support ticket so we can assist quickly.
Last updated