Retrieve a list of all appointments.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Query
start*
Date
Start of the search
end*
Date
End of the search
Request Example
Responses
List of appointments received successfully
Authorization information missing, expired or invalid
Creates a new appointment.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Content-Type*
string
application/json
Body
customerId*
string
Customer who receives this appointment
serviceId*
string
Service that the customer is booking
teamMemberId
string
Team member who receives this appointment - leave empty if any available team member should get assigned
date*
Date
When the appointment will occur - has to be greater than now and a time slot is required
timeZone
string
Time zone (e.g. America/Los_Angeles) for the date - defaults to the business time zone
notes
string
Optional notes for the appointment
Request Example
Responses
Appointment created successfully
Authorization information missing, expired or invalid
GET/api/v1/appointments/{id}
Retrieve a specific appointment by ID.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Path
id*
string
ID of the appointment to get
Request Example
Responses
Appointment received successfully
Authorization information missing, expired or invalid
DELETE/api/v1/appointments/{id}
Delete a specific appointment by ID.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Path
id*
string
ID of the appointment to delete
Request Example
Responses
Appointment deleted successfully
Authorization information missing, expired or invalid
POST/api/v1/appointments/{id}/cancel
Cancels a specific appointment by ID.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Content-Type*
string
application/json
Path
id*
string
ID of the appointment to cancel
Body
cancellationReason*
string
Message that will be send via email to the customer
Request Example
Responses
Appointment canceled successfully
Authorization information missing, expired or invalid