Skip to main content

Booking Services API

The Booking Services API is the interface your RMS exposes so Mozrest can query availability, create bookings, and process payments on behalf of booking channels.

When is this needed?

In a standard integration, your RMS exposes an API that matches 100% of Mozrest's specifications described below. Mozrest calls your endpoints directly using this contract.

If Mozrest integrates with your existing API instead (custom integration), you can skip this section — Mozrest adapts to your interface.

Base URL

All endpoints must be served under a fixed path structure:

https://{your-domain}/v1/mozrest

The /v1/mozrest segment is mandatory. Mozrest appends each endpoint path to this base (e.g. /v1/mozrest/healthcheck, /v1/mozrest/availability).

Endpoints Overview

EndpointMethodPurpose
AuthenticationHow Mozrest authenticates requests to your API
HealthCheckGETVerify your API is operational
Get Venue AvailabilityGETQuery bookable slots for a venue
Create BookingPOSTCreate a new reservation
Update BookingPUTModify an existing reservation
Cancel BookingDELETECancel a reservation
Find a Booking by IDGETRetrieve a specific booking
Search BookingsGETSearch bookings by criteria
PaymentsDeposit and card guarantee handling