GET /appointments

Get a list of appointments currently scheduled for the authenticated user.

Servers

Query parameters

Name Type Required Description
calendarID Integer No

show only appointments on calendar with specified ID

canceled Boolean No

get canceled appointments

Default value: false

maxDate String No

only get appointments this date and before

field:id String No

filter appointments matching a particular custom intake form field eg. ?field:1234=Hello

appointmentTypeID Integer No

show only appointments of this type

email String No

filter appointments for client e-mail address

direction String No

ASC or DESC

Default value: "DESC"

lastName String No

filter appointments for client last name

minDate String No

only get appointments this date and after

max Integer No

maximum number of results

Default value: 100

phone String No

filter appointments for client phone

firstName String No

filter appointments for client first name

excludeForms Boolean No

don't include intake forms in the response object (speeds up the response)

Default value: false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.