# Bookings VenueAPI

Bookings VenueAPI is a RESTful, OpenAPI-based interface that enables seamless, standardized booking operations across diverse venue management systems (RMS). 

Designed for maximum interoperability, the API allows platforms to search, discover, and book venues regardless of the underlying technology stack. 

Key capabilities include:
- Retrieving venue data and availability in real-time
- Creating bookings through a unified interface
- Supporting both direct bookings and inquiry-based workflows
- Enabling venues and distributors to discover each other via a dynamic, service-driven marketplace

The API supports RBAC-secured OAuth2 to ensure role-based access control and secure data transactions. Built for SaaS environments, this service offers scalable, multi-tenant integrations for distribution platforms, booking engines, and RMS providers.


Version: 4.11.0-SNAPSHOT

## Servers

Staging
```
https://api-staging.bookabletech.com
```

Production
```
https://api.bookabletech.com
```

## Security

### Staging

This API uses OAuth2 client credentials flow via Auth0.
**Important:** Include the `audience` parameter in your token request.
Example token request:
```
POST https://bookabletech.uk.auth0.com/oauth/token
{
  "grant_type": "client_credentials",
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "audience": "api.bookabletech.com"
}
```


Type: oauth2

### Production

This API uses OAuth2 client credentials flow via Auth0.
**Important:** Include the `audience` parameter in your token request.
Example token request:
```
POST https://auth.bookabletech.com/oauth/token
{
  "grant_type": "client_credentials",
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "audience": "api.bookabletech.com"
}
```


Type: oauth2

## Download OpenAPI description

[Bookings VenueAPI](https://docs.bookabletech.com/_bundle/apis/staging/BookingApi-staging.yaml)

## Venue

Information about venue

### Retrieve a list of venues

 - [GET /venues](https://docs.bookabletech.com/apis/staging/bookingapi-staging/venue/getvenues.md): Returns a paginated list of venues available to the authenticated user or system.  This endpoint supports page-based pagination to efficiently retrieve large sets of results.

### Get the venue

 - [GET /venues/{venueId}](https://docs.bookabletech.com/apis/staging/bookingapi-staging/venue/getvenue.md): Retrieve a list of venues.

### Check venue availability

 - [GET /venues/{compositeId}/availability](https://docs.bookabletech.com/apis/staging/bookingapi-staging/venue/checkvenueavailability.md)

### Create a new booking

 - [POST /venues/{compositeId}/booking](https://docs.bookabletech.com/apis/staging/bookingapi-staging/venue/createbooking.md)

### Retrieve a list of bookings

 - [GET /venues/bookings](https://docs.bookabletech.com/apis/staging/bookingapi-staging/venue/getbookings.md): Returns a paginated list of all bookings.

### Retrieve a booking by ID

 - [GET /venues/bookings/{bookingId}](https://docs.bookabletech.com/apis/staging/bookingapi-staging/venue/getbookingbyid.md): Returns a specific booking by its unique ID.

### Update an existing booking by ID

 - [PUT /venues/bookings/{bookingId}](https://docs.bookabletech.com/apis/staging/bookingapi-staging/venue/updatebookingbyid.md)

### Cancel a booking by ID

 - [DELETE /venues/bookings/{bookingId}](https://docs.bookabletech.com/apis/staging/bookingapi-staging/venue/deletebookingbyid.md)

### Create a new booking

 - [POST /venues/{compositeId}/booking](https://docs.bookabletech.com/apis/staging/bookingapi-staging/booking/createbooking.md)

### Retrieve a list of bookings

 - [GET /venues/bookings](https://docs.bookabletech.com/apis/staging/bookingapi-staging/booking/getbookings.md): Returns a paginated list of all bookings.

### Retrieve a booking by ID

 - [GET /venues/bookings/{bookingId}](https://docs.bookabletech.com/apis/staging/bookingapi-staging/booking/getbookingbyid.md): Returns a specific booking by its unique ID.

### Update an existing booking by ID

 - [PUT /venues/bookings/{bookingId}](https://docs.bookabletech.com/apis/staging/bookingapi-staging/booking/updatebookingbyid.md)

### Cancel a booking by ID

 - [DELETE /venues/bookings/{bookingId}](https://docs.bookabletech.com/apis/staging/bookingapi-staging/booking/deletebookingbyid.md)

## Booking

Information about the booking

### Create a new booking

 - [POST /venues/{compositeId}/booking](https://docs.bookabletech.com/apis/staging/bookingapi-staging/venue/createbooking.md)

### Retrieve a list of bookings

 - [GET /venues/bookings](https://docs.bookabletech.com/apis/staging/bookingapi-staging/venue/getbookings.md): Returns a paginated list of all bookings.

### Retrieve a booking by ID

 - [GET /venues/bookings/{bookingId}](https://docs.bookabletech.com/apis/staging/bookingapi-staging/venue/getbookingbyid.md): Returns a specific booking by its unique ID.

### Update an existing booking by ID

 - [PUT /venues/bookings/{bookingId}](https://docs.bookabletech.com/apis/staging/bookingapi-staging/venue/updatebookingbyid.md)

### Cancel a booking by ID

 - [DELETE /venues/bookings/{bookingId}](https://docs.bookabletech.com/apis/staging/bookingapi-staging/venue/deletebookingbyid.md)

### Create a new booking

 - [POST /venues/{compositeId}/booking](https://docs.bookabletech.com/apis/staging/bookingapi-staging/booking/createbooking.md)

### Retrieve a list of bookings

 - [GET /venues/bookings](https://docs.bookabletech.com/apis/staging/bookingapi-staging/booking/getbookings.md): Returns a paginated list of all bookings.

### Retrieve a booking by ID

 - [GET /venues/bookings/{bookingId}](https://docs.bookabletech.com/apis/staging/bookingapi-staging/booking/getbookingbyid.md): Returns a specific booking by its unique ID.

### Update an existing booking by ID

 - [PUT /venues/bookings/{bookingId}](https://docs.bookabletech.com/apis/staging/bookingapi-staging/booking/updatebookingbyid.md)

### Cancel a booking by ID

 - [DELETE /venues/bookings/{bookingId}](https://docs.bookabletech.com/apis/staging/bookingapi-staging/booking/deletebookingbyid.md)