Return intake forms.

Response Attributes

Attribute

Description

id

form ID

name

the name of the form

description

the description of the form

hidden

whether or not the form is internal and hidden from clients

appointmentTypeIDs

the IDs of the appointment types the form is assigned to

fields

the list of form fields

Form Fields

Form fields are returned with the rest of the forms data. This list can be used to build a custom scheduler which supports intake forms, just be sure to implement each type of form field you're using!

Attribute

Description

id

the field ID

name

the field name

required

whether or not the field is required for clients

type

the field type, one of textbox, textarea, dropdown, checkbox, checkboxlist, yesno, file, or address

options

the list of options for dropdown and checkboxlist fields

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!