/v3/appointment/customFields

By default, all Custom Fields defined on every Location, Service, and Resource will be returned. Specify specific Locations, Services, and Resources using the query parameters.

View Endpoint in V1

🚀

Custom Fields UNLEASHED

No more limits to your custom fields! An infinite number of fields can be created and managed in any way that suits your business best. These fields are now stored as key value pairs on the Appointment, Customer, Service, and Resource, where they can be fetched for use on your booking pages.

The recommended usage is to match the key of your booking field questions, which are stored as fields on the Resource/Service/Customer, to the key of the field that you are creating on the Appointment.
For example:

  1. Make a GET request to the Service that is selected to be booked, and store the question to use on the booking form

    {
      Service: {
        CustomFields: {
          "booking_question_1": "What's your favourite movie?"
        }
      }
    }
    
  2. Capture the answer your booking field question in the payload of your POST request to Create the Appointment

    {  
      Appointment: {  
        CustomFields: {  
          "booking_quesion_1": "Back To The Future!"  
      	}  
      }  
    }
    
Language
Credentials
URL
Click Try It! to start a request and see the response here!