Home Acuity Scheduling Acuity Appointment Example
Acuity Appointment Example
Scheduling Appointments Calendar Booking HIPAA Webhooks
Acuity Appointment Example is an example object payload from Acuity Scheduling, with 31 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
id firstName lastName phone email date time endTime dateCreated datetime price paid amountPaid type appointmentTypeID addonIDs classID category duration calendar calendarID canClientCancel canClientReschedule location certificate confirmationPage formsText notes timezone forms labels
Example Payload
{
"id": 54321,
"firstName": "Bob",
"lastName": "McTest",
"phone": "",
"email": "bob.mctest@example.com",
"date": "July 2, 2013",
"time": "10:15am",
"endTime": "11:15am",
"dateCreated": "June 17, 2013",
"datetime": "2013-07-02T10:15:00-0700",
"price": "10.00",
"paid": "no",
"amountPaid": "0.00",
"type": "Regular Visit",
"appointmentTypeID": 1,
"addonIDs": [1],
"classID": null,
"category": "",
"duration": "60",
"calendar": "My Calendar",
"calendarID": 27238,
"canClientCancel": false,
"canClientReschedule": false,
"location": "",
"certificate": null,
"confirmationPage": "https://acuityscheduling.com/schedule.php?owner=11145481&id[]=1220aa9f41091c50c0cc659385cfa1d0&action=appt",
"formsText": "...",
"notes": "Notes",
"timezone": "America/New_York",
"forms": [
{
"id": 1,
"name": "Example Intake Form",
"values": [
{
"value": "yes",
"name": "Is this your first visit?",
"fieldID": 1,
"id": 21502993
},
{
"value": "Ninja",
"name": "What is your goal for this appointment?",
"fieldID": 2,
"id": 21502994
}
]
}
],
"labels": [
{
"id": 3,
"name": "Completed",
"color": "pink"
}
]
}