Skip to content
MyHallWizard
  • Home
  • Features
  • Demo
  • Pricing
  • Contact
  • Support
  • Login
Sign Up

Sign up now for a 6 week free trial.  No credit card required.

MyHallWizard

Sign up now for a 6 week free trial.  No credit card required.

Getting Started

  • Importing Customer Data
  • Importing Bookings
  • Set up Invoices and Payments
  • Sign Up for MyHallWizard
  • Create a new venue
  • What happens at the end of my free trial?

Customers and Bookings

  • Price Lists
  • How can I make repeat bookings every other week?
  • How can I make repeat bookings every other month?
  • How to book an event on the 2nd Thursday every month
  • Make a repeat booking for a customer on the 2nd and 4th Thursday of the month
  • Importing Customer Data
  • Importing Bookings
  • Can I send an invoice to a group treasurer instead of the main contact for my Customer?
  • Public calendars
  • Why can’t I send my email?
  • Deleting Customers
  • Calendar Settings
  • Enabling Booking Requests
  • Managing Booking Requests
  • Provisional Bookings
  • GDPR
  • Printing Reports

Invoices and Payments

  • Mark an invoice as paid
  • Can I send an invoice to a group treasurer instead of the main contact for my Customer?
  • Personalising your invoices for your customer
  • Set up Invoices and Payments
  • I accidentally invoiced a cancelled booking
  • Handling Overpayments
  • Credit Notes and Refunds
  • Deposits / Bonds
  • Invoicing
  • Printing Reports
  • Sales Taxes (VAT / GST)
  • Card Payments using Stripe

Configuration

  • Price Lists
  • Personalising your invoices for your customer
  • Set up Invoices and Payments
  • Create a new venue
  • Change the date format
  • Public calendars
  • How to delete a venue
  • Email Templates
  • Calendar Settings
  • Enabling Booking Requests

Managing your Account

  • Inviting users to your account
  • How to delete a venue
  • Managing your subscription
  • What happens at the end of my free trial?

Integrations

  • Export Invoices to Xero
  • RemoteLock
  • iCal feeds
  • Inspire Home Automation
  • Card Payments using Stripe

API

  • public-bookings
  • Home
  • Knowledge Base
  • API
  • public-bookings

public-bookings

Table of Contents
  • List of Methods
  • Attributes of the public-booking object
  • Methods
    • Retrieve upcoming public bookings
      • Endpoint
      • Parameters
      • HTTP response
      • Sample response body

Public bookings contain the same information as is available in the public calendar. They do not include booking requests.

List of Methods #

In the following endpoints, {slug} needs to be replaced with the same slug as used in the Calendar URL (see Settings -> Venue Details). For example, if your Calendar URL is https://app.myhallwizard.com/dakeford-village-hall, the slug is dakeford-village-hall.

MethodEndpoint
Retrieve upcoming public bookingsGET https://app.myhallwizard.com/api/v0/{slug}/public-bookings

The methods are described below.

Attributes of the public-booking object #

The public-bookings object looks like this:

{
    "id": 77957,
    "uuid": "fce1ebcc-1571-414a-9607-95cdb02b5985",
    "name": "Art Group",
    "confirmed": 1,
    "private": 0,
    "booking_dt": "2022-09-09",
    "start_tm": "14:00:00",
    "end_tm": "16:00:00",
    "details": "<p>The Art Group meets every Friday afternoon between 2pm and 4pm.&nbsp; New members are always welcome.</p>\r\n<p>Contact Jane Doe on 01234 567890 for more information.&nbsp;</p>",
    "room_names": "Main Hall, Side Room",
    "created_at": "2022-09-09T10:23:43.000000Z",
    "updated_at": "2022-09-09T10:26:28.000000Z"
}

Attributes in the object are as follows:

  • id -internal id of the booking (provided for compatibility when we build a full API in the future)
  • uuid – public id of the booking
  • name – the booking name. If the booking is private, name is always “Private booking”. For provisional bookings, there is no indication of this in the name field – the client is responsible for determining how provisional bookings are displayed based on the confirmed attribute
  • confirmed – 1 if the booking is confirmed, 0 if it is provisional
  • private – 0 if the booking is public, 1 if it is private
  • booking_dt – the date of the booking in YYYY-MM-DD format
  • start_tm – start time of the booking in HH:MM:SS format using the local timezone
  • end_tm – end time of the booking in HH:MM:SS format using the local timezone
  • details – the details field as an HTML string. If the booking is private, the details field is always null
  • room_names – the names of the rooms booked, e.g. “Main Hall, Side Room”
  • created_at – the date and time the booking was created
  • updated_at – the date and time the booking was last updated

Methods #

Retrieve upcoming public bookings #

This method retrieves an array of upcoming public bookings starting from today onwards, sorted by booking_dt and start_tm. Bookings today which have already ended are excluded. By default, only public and confirmed bookings are retrieved, though this can be overridden with parameters.

No authentication is needed to use this API, therefore only publicly available information is returned. For example, extras and administration notes are not returned.

As for the public calendar, the venue needs to have its public calendar enabled, and be on a free trial or subscribed.

Endpoint #

GET https://app.myhallwizard.com/api/v0/{slug}/public-bookings

Parameters #

The endpoint can take the following parameters:

  • days – number of days data to retrieve starting from today (e.g. days=7 returns 7 days of data. If today is Friday, this would be public bookings through until next Thursday). Valid values are 1 to 365. Default is 5.
  • limit – the maximum number of bookings to retrieve. Valid values are 1 to 1000. Default limit is 100.
  • include_private – set to 1 to include private bookings in the result set, or 0 to exclude them. Default is 0.
  • include_provisional – set to 1 to include provisional bookings in the result set, or 0 to exclude them. Default is 0

HTTP response #

We use standard HTTP response codes. A successful call will return an HTTP code 200. Any other return code should be treated as an exception. Codes in the 400 series represent something wrong with your query – check the response body for more information. Codes in 500 series mean something went wrong in our server.

Responses you are most likely to encounter for this API call are:

  • 200 – OK
  • 400 – Bad Request – one of the parameters in your API call failed validation
  • 403 – Forbidden – usually because the public calendar is not enabled for your venue or the venue does not have an active subscription. This error can also occur if our firewall blocks your call; contact HallWizard Support for assistance in this instance.
  • 404 – Not Found – usually means the slug is incorrect

Sample response body #

[
    {
        "id": 77957,
        "uuid": "fce1ebcc-1571-414a-9607-95cdb02b5985",
        "name": "Art Group",
        "confirmed": 1,
        "private": 0,
        "booking_dt": "2022-09-09",
        "start_tm": "14:00:00",
        "end_tm": "16:00:00",
        "details": "<p>The Art Group meets every Friday afternoon between 2pm and 4pm.&nbsp; New members are always welcome.</p>\r\n<p>Contact Jane Doe on 01234 567890 for more information.&nbsp;</p>",
        "room_names": "Main Hall, Side Room",
        "created_at": "2022-09-09T10:23:43.000000Z",
        "updated_at": "2022-09-09T10:26:28.000000Z"
    },
    {
        "id": 36498,
        "uuid": "c0751e0f-d95b-4baa-bdb0-03528b648c6c",
        "name": "Brass Band",
        "confirmed": 1,
        "private": 0,
        "booking_dt": "2022-09-10",
        "start_tm": "19:30:00",
        "end_tm": "22:00:00",
        "details": null,
        "room_names": "Main Hall",
        "created_at": "2022-04-11T16:33:28.000000Z",
        "updated_at": "2022-08-25T07:46:08.000000Z"
    }
]

Related #

Still stuck? How can we help?

How can we help?

Updated on 7 December 2022
Table of Contents
  • List of Methods
  • Attributes of the public-booking object
  • Methods
    • Retrieve upcoming public bookings
      • Endpoint
      • Parameters
      • HTTP response
      • Sample response body
  • Home
  • Login
  • Sign Up
  • Contact
  • Support
  • Terms and Conditions
  • Privacy Policy
  • Cookie Policy
  • Service Status

© 2023 HallWizard Limited

HallWizard Limited. Registered in England and Wales, no. 12763234. Registered office: Office 9, Dalton House, 60 Windsor Avenue, London SW19 2RR

Manage Cookie Consent
We use cookies to optimize our website and our service.
Functional Always active
The technical storage or access is strictly necessary for the legitimate purpose of enabling the use of a specific service explicitly requested by the subscriber or user, or for the sole purpose of carrying out the transmission of a communication over an electronic communications network.
Preferences
The technical storage or access is necessary for the legitimate purpose of storing preferences that are not requested by the subscriber or user.
Statistics
The technical storage or access that is used exclusively for statistical purposes. The technical storage or access that is used exclusively for anonymous statistical purposes. Without a subpoena, voluntary compliance on the part of your Internet Service Provider, or additional records from a third party, information stored or retrieved for this purpose alone cannot usually be used to identify you.
Marketing
The technical storage or access is required to create user profiles to send advertising, or to track the user on a website or across several websites for similar marketing purposes.
Manage options Manage services Manage vendors Read more about these purposes
View preferences
{title} {title} {title}
  • Home
  • Features
  • Demo
  • Pricing
  • Contact
  • Support