acuityscheduling
Appointment scheduling and workflow automation
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://acuityscheduling.com/api/v1 | link | — | — | — |
Actions (55)
Appointments · 7
- Cancel appointmentPUT /appointments/{id}/cancel
Cancel an appointment.
documented - Create appointmentPOST /appointments
Create a new appointment.
documented - Get appointmentGET /appointments/{id}
Get a single appointment by ID.
documented - List appointment paymentsGET /appointments/{id}/payments
Retrieve payment transactions for a specific appointment.
documented - List appointmentsGET /appointments
Get a list of appointments currently scheduled for the authenticated user.
documented - Reschedule appointmentPUT /appointments/{id}/reschedule
Reschedule an appointment.
documented - Update appointmentPUT /appointments/{id}
Update an appointment's details (a whitelist of updatable attributes).
documented
Calendars · 6
- Delete calendarDELETE /api/enterprise/v2/enterprises/{enterpriseId}/calendars/{calendarId}
Delete a calendar.
documented - Get calendarGET /api/enterprise/v2/enterprises/{enterpriseId}/calendar/{calendarId}
Retrieve a calendar by ID.
documented - List calendarsGET /calendars
Retrieve calendars this user has access to.
documented - List calendars for instanceGET /api/enterprise/v2/enterprises/{enterpriseId}/instance/{instanceId}/calendars
List calendars for an Enterprise Scheduling Instance.
documented - List calendars for instanceGET /api/enterprise/v2/enterprises/{enterpriseId}/instance/{instanceId}/calendars
List calendars for a Scheduling Instance.
documented - Update calendarPATCH /api/enterprise/v2/enterprises/{enterpriseId}/calendars/{calendarId}
Update a calendar.
documented
Scheduling Instance · 6
- Create scheduling instancePOST /api/enterprise/v2/enterprises/{enterpriseId}/instances
Create a new Scheduling Instance.
documented - Delete scheduling instanceDELETE /api/enterprise/v2/enterprises/{enterpriseId}/instance/{instanceId}
Delete a Scheduling Instance.
documented - Get scheduling instanceGET /api/enterprise/v2/enterprises/{enterpriseId}/instance/{instanceId}
Fetch a Scheduling Instance.
documented - List scheduling instancesGET /api/enterprise/v2/enterprises/{enterpriseId}/instances
Fetch the list of Scheduling Instances for the enterprise.
documented - Update scheduling instancePATCH /api/enterprise/v2/enterprises/{enterpriseId}/instance/{instanceId}
Update a Scheduling Instance.
documented - Validate subdomainGET /api/enterprise/v2/validate-subdomain/{subdomain}
Validate a subdomain for a new Scheduling Instance.
documented
Org Member · 5
- Add user to instancePOST /api/enterprise/v2/enterprises/{enterpriseId}/instance/{instanceId}/users/{userId}
Add a user to an enterprise instance.
documented - Get user permissions for instanceGET /api/enterprise/v2/enterprises/{enterpriseId}/instance/{instanceId}/users/{userId}/permissions
Fetch a user's permissions for an enterprise instance.
documented - Get user permissions on instanceGET /api/enterprise/v2/enterprises/{enterpriseId}/instance/{instanceId}/users/{userId}/permissions
Fetch a user’s permissions on an enterprise instance.
documented - Remove user from instanceDELETE /api/enterprise/v2/enterprises/{enterpriseId}/instance/{instanceId}/users/{userId}
Remove a user from an enterprise instance.
documented - Update user on instancePATCH /api/enterprise/v2/enterprises/{enterpriseId}/instance/{instanceId}/users/{userId}
Update a user’s permissions for an enterprise instance.
documented
Availability · 4
- Check availability timesPOST /availability/check-times
Validate available times for an appointment.
documented - List availability classesGET /availability/classes
Return available classes for a given month.
documented - List availability datesGET /availability/dates
Return dates with availability for a month and an appointment type.
documented - List availability timesGET /availability/times
Return available times for a date and appointment type.
documented
Blocks · 4
Certificates · 4
- Check certificateGET /certificates/check
Check that a certificate code is valid for a particular appointment type.
documented - Create certificatePOST /certificates
Create a package or coupon certificate.
documented - Delete certificateDELETE /certificates/{id}
Delete a certificate code.
documented - List certificatesGET /certificates
Get package certificates.
documented