Build custom hotel frontends with our unified API
The official frontend/ guest portal is the first consumer of this API. Use these endpoints to implement your own white-label guest experiences, mobile applications, check-in kiosks, and bespoke concierge integrations.
Core Architectural Principles
Understanding the security and multi-tenancy model ensures seamless frontend integrations.
Tenant Isolation
Every request requires an X-API-Key: hak_live_.... All queries for rooms, pricing, CMS blocks, and folios are automatically scoped to that specific hotel property.
Guest Session JWTs
Upon logging in or registering, guests receive an access JWT. Authenticated endpoints (creating bookings, viewing folios, room service) require Authorization: Bearer <token>.
Realtime Sync to PMS
Bookings, guest check-ins, and room service orders placed via your custom frontend instantly reflect on the hotel staff's desktop and offline PMS without delay.
Quickstart: 3-Step Lifecycle
Follow the exact sequence implemented in the reference guest application.
# 1) Fetch Hotel Branding & Settings
curl -s "https://api.thegrandeur.vip/api/v1/public/tenant/config" \
-H "X-API-Key: hak_live_YOUR_KEY"
# 2) Authenticate Guest
curl -s -X POST "https://api.thegrandeur.vip/api/v1/auth/login" \
-H "Content-Type: application/json" \
-H "X-API-Key: hak_live_YOUR_KEY" \
-d '{
"email": "[email protected]",
"password": "••••••••",
"audience": "guest_site",
"api_key": "hak_live_YOUR_KEY"
}'
# 3) Query Available Rooms for Dates
curl -s "https://api.thegrandeur.vip/api/v1/rooms/available?check_in=2026-10-01&check_out=2026-10-05" \
-H "X-API-Key: hak_live_YOUR_KEY"
API Endpoint Reference
Explore the complete collection of guest APIs consumed by the reference frontend.
Guest registration, email login, Google OAuth, and /auth/me.
Query room catalogs, room types, and live calendar availability.
Create reservations, mobile self check-in, extend stays, and folios.
Digital restaurant menus, order placement, and kitchen tracking.
In-room service requests (towels, housekeeping, spa, concierge).
Ancillary amenities, gym/pool day passes, and subscriptions.
Initialize gateway checkout (Stripe/Paystack) and fetch tax rates.
Fetch dynamic branding colors, logos, and custom website CMS blocks.
Hardware Bridge & Server Webhooks
Looking to connect physical hotel hardware (RFID door lock encoders, ESC/POS kitchen printers) or configure server-to-server OTA synchronization?