Skip to main content
GET
/
Bookings
/
schedule
GET /Bookings/schedule
curl --request GET \
  --url https://{base_url}/Bookings/schedule \
  --header 'X-API-KEY: <x-api-key>'
Get available booking time slots for a given date and party size. Optionally pass an existing booking ID to find alternative times for rescheduling.
X-API-KEY
string
required
Your API key
BookingDateTimeStart
string
required
Start of date range. Format: yyyy-MM-ddTHH:mm:ss.fffZ
NumOfPeople
integer
required
Number of guests
BookingDateTimeEnd
string
End of date range. If not provided, returns slots for the entire day.
BookingId
string
Existing booking ID to find alternative slots for rescheduling.
curl --location '[BASE_URL]/Bookings/schedule?BookingDateTimeStart=2024-03-20T00:00:00.000Z&NumOfPeople=4' \
--header 'X-API-KEY: your_api_key_here'
Response is an array of ScheduleQueryResponse objects. ScheduleQueryResponse
FieldTypeNullableDescription
isVenueOpenbooleanNoWhether the venue is open
blockoutMessagestringYesWhy venue is blocked out. Present when isVenueOpen is false
servicesarray of ServiceModelYesAvailable services with time slots
ServiceModel
FieldTypeNullableDescription
idstringYesService identifier
namestringYesService name
onlinebooleanNoAccepts online bookings
durationintegerNoDefault duration in minutes
descriptionstringYesService description
serviceTypestringYesType (e.g. dining)
policyAgreementstringYesPolicy title shown at booking
policyAgreementTextstringYesFull policy text
sectionsarray of SectionModelYesAvailable venue sections
timesarray of TimeModelYesAvailable time slots
paymentDetailsServicePaymentNoPayment configuration
SectionModelid (string), name (string), order (integer) TimeModeltime (string UTC datetime), name (string, e.g. “6:00 PM”), expired (boolean), bookingOptionsCount (integer), sections (array of { id, sectionState: boolean }) ServicePaymentpaymentType, peopleRequired, price, fee, optionsFrom, optionsTo, maxPeoplePerBookingOverride, hasPromotion, singleMenuPerBooking Example 200 Response
[
  {
    "isVenueOpen": true,
    "blockoutMessage": null,
    "services": [
      {
        "id": "svc-101",
        "name": "Dinner Service",
        "online": true,
        "duration": 90,
        "description": "Standard dinner bookings",
        "serviceType": "dining",
        "sections": [
          { "id": "sec-1", "name": "Main Floor", "order": 1 }
        ],
        "times": [
          {
            "name": "6:00 PM",
            "expired": false,
            "bookingOptionsCount": 3,
            "time": "2024-03-20T18:00:00Z",
            "sections": [{ "id": "sec-1", "sectionState": true }]
          }
        ],
        "paymentDetails": {
          "paymentType": "none",
          "peopleRequired": 0,
          "price": 0.00,
          "fee": 0.00,
          "hasPromotion": false,
          "singleMenuPerBooking": false
        }
      }
    ]
  }
]
StatusDescription
200Schedule returned
400loggedInAppId
400No Venue Subscribed to your App.
400requested Date is not in correct format '{DateTimeISO8601Format}'.
401X-API-KEY missing or invalid
429Rate limit exceeded