🧩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

1. Generate an API key: API Access

2. Add the key to your request headers: Authentication

3. Call your first endpoint — for example Bookings Create

Core Guides

• Authentication: required headers and rate limits — read more

• Booking Engine API: surface availability on your website — 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-Key on POST and PATCH requests — it is required, not optional; missing it returns 400

• Respect the 120 req/min limit 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 [e-mail] when opening a support ticket so we can assist quickly.