# Saoma API

> Integrate Saoma spa availability and bookings into your platform.

## Docs

- [Get availability](https://docs.saoma.io/api-reference/availability/get-availability.md): Fetch real-time bookable slots for one or more venues.
- [Cancel a booking](https://docs.saoma.io/api-reference/bookings/cancel-booking.md): Cancel an existing booking.
- [Create a booking](https://docs.saoma.io/api-reference/bookings/create-booking.md): Push a new booking into a venue's agenda.
- [Retrieve a booking](https://docs.saoma.io/api-reference/bookings/get-booking.md): Fetch the current state of a booking.
- [List a customer's bookings at a venue](https://docs.saoma.io/api-reference/customers/list-customer-bookings.md): Paginated history of a single customer's bookings at one venue.
- [List customers of a venue](https://docs.saoma.io/api-reference/customers/list-customers.md): Paginated list of the customers who have booked at a venue, with per-venue aggregated stats.
- [Retrieve a venue](https://docs.saoma.io/api-reference/venues/get-venue.md): Fetch a single venue's public profile.
- [List treatments](https://docs.saoma.io/api-reference/venues/list-treatments.md): List the active treatments of a venue.
- [List venues](https://docs.saoma.io/api-reference/venues/list-venues.md): List every active venue accessible to your API key.
- [Authentication](https://docs.saoma.io/authentication.md): Authenticate your requests to the Saoma Partner API with an API key.
- [Availability](https://docs.saoma.io/concepts/availability.md): How Saoma computes real-time bookable slots.
- [Bookings](https://docs.saoma.io/concepts/bookings.md): Lifecycle of a booking created through the Partner API.
- [Customers](https://docs.saoma.io/concepts/customers.md): End clients of a venue, with their profile and booking history.
- [Treatments](https://docs.saoma.io/concepts/treatments.md): Services offered by a venue (massages, facials, body wraps…).
- [Venues](https://docs.saoma.io/concepts/venues.md): Spas and hotel spas connected to Saoma.
- [Errors](https://docs.saoma.io/errors.md): Error format returned by the Partner API.
- [Quickstart](https://docs.saoma.io/guides/quickstart.md): Read venues and treatments from the Saoma Partner API in 5 minutes.
- [Introduction](https://docs.saoma.io/introduction.md): Integrate Saoma spa availability and bookings into your platform.
- [Rate limits](https://docs.saoma.io/rate-limits.md): Usage quotas applied per API key.

## OpenAPI Specs

- [openapi](https://docs.saoma.io/api-reference/openapi.json)