Get Venue Availability

This endpoint retrieves a list of available booking slots for a specified Venue on a particular date, session, and party size. The returned data includes session details, slot availability, and optional deposit requirements, providing Mozrest with real-time access to open reservations.

Endpoint

GET https://partner-domain.com/v1/mozrest/availability

Query Parameters

Parameter	Status	Description
venueId	Mandatory	The unique Venue ID as defined in the Partner's system. `ID in Partner's system`
date	Mandatory	The specific date to check for availability (format: YYYY-MM-DD).
partySize	Mandatory	Number of people for the reservation (e.g., 4).
areaId	Optional	Specific Area ID for location within the venue if applicable. `ID in Partner's system`

Example Request

curl GET "https://partner-domain.com/v1/mozrest/availability" \
  -H "Authorization: Bearer {{api_key}}" \
  -d "venueId='60e5a3ed409541da3650bd90'" \
  -d "date=2022-02-14" \
  -d "partySize=4",
  -d "areaId=60e5a3ed409541da3650b2d3"

Example Response

The response includes key details for each available slot, such as session, slot timing, and any deposit or credit card requirements.

{
  "venueId": "60e5a3ed409541da3650bd90",
  "date": "2022-02-14",
  "partySize": 4,
  "duration": 3600,
  "slotData": [
    {
      "startSec": 1644847200,
      "totalSpot": 100,
      "openSpot": 75,
      "deposit": true,
      "depositAmount": 10000,
      "requireCc": false
    },
    {
      "startSec": 1644849000,
      "totalSpot": 100,
      "openSpot": 75,
      "deposit": true,
      "depositAmount": 10000,
      "requireCc": false
    }
  ],
  "nextAvailability": 1639558800
}

Response Definitions

venueId: Unique identifier for the venue within the partner's system.
date: Date of availability in YYYY-MM-DD format.
partySize: Number of people the booking is for.
duration: Duration of each available slot in seconds.
slotData: Array of available time slots, each with details:
- startSec: Start time in UTC Unix timestamp format.
- totalSpot: Maximum spots for the specific slot.
- openSpot: Number of spots currently available for the slot.
- deposit: Boolean indicating if a deposit is required for the slot.
- depositAmount: Required deposit amount in cents (e.g., 10000 for 100.00).
- requireCc: Boolean indicating if a credit card is required for booking.
nextAvailability: Timestamp of the next available slot after the queried date. Only to provide if no slots are available.