Introduction

Hostme API is the REST API of the Hostme restaurant management platform. Partners and third-party services (POS, CRM, booking widgets, marketplaces, telephony) use it to integrate with a restaurant: create and read reservations, check table availability, work with guests, sync menus and orders.

This documentation is based on the actual Hostme API v1 specification (Swagger UI). All paths, field names and data types are taken directly from the specification.

Who this documentation is for

• Reservation integrators — external widgets, marketplaces, aggregators, phone services that need to create and sync bookings.
• POS / CRM systems — that need to exchange guests, orders and inventory.
• Partner apps — embedded services acting on behalf of a restaurant.

Basic format

Property	Value
Protocol	HTTPS
Format	JSON (application/json)
Encoding	UTF-8
Authentication	OAuth2, Bearer token in the Authorization header
Base URL (production)	https://api.hostmeapp.com
Version	v1

The specification has no servers block — the base URL is the host where Swagger is served: https://api.hostmeapp.com. The test environment is https://api-qa.hostmeapp.com.

Path structure

Endpoints are grouped by platform subsystem. The path prefix identifies the subsystem:

Prefix	Subsystem
/api/core/...	Accounts, restaurants, core entities
/api/rsv/...	Reservations, availability, requests
/api/loyalty/...	Guests (guest book, profiles)
/api/tm/...	Tables and floor management (table management)
/api/pos/...	POS / vendor app integration

Almost all “restaurant” endpoints are addressed by the restaurant’s numeric identifier: /api/.../restaurants/{restaurantId}/.... More in Core Concepts.

Where to start

1. Read Environments & Access — where the production and test environments are, how to get credentials.
2. Set up Authentication — obtain a Bearer token.
3. Go through the Quick Start — an end-to-end “token → availability → booking” example.
4. Then by section: Reservations, Guests, Menu.

Documentation status

This is living documentation. The first version covers the partner layer of the Hostme API: reservations, availability, guests, menu and orders, waitlist, tables, events, payments. Internal and service endpoints (messenger webhooks, the AI agent, test controllers) are not included.

The Chat API is a separate service. Receiving/sending messages (inbound messages, delivery statuses, notification channels) live in a separate Chat API on a different host and are not part of this documentation. For guest notifications triggered by booking events, see Messaging & Notifications.