Reservations
Get Reservations
GET https://yourdomain.com/apibaseurl/reservations/get/
Get reservation entries.
Query Parameters
200 Reservations successfully retrieved.
Response Response with full data
Copy {
"response": [
{
"id" : "r_MP4WdkOw32TSain2tjORQFD3KPikzWTp",
"db_id" : "13",
"serviceId" : "s_AO4WdkOw32XSyrn2tjORQFD4KPikzWTK",
"providerId" : 3
"customerId" : "c_AO4WdkOw32XSyrn2tjORQFD4KPikzWTK",
"start" : 1567949246
"end" : 1567949564,
"status" : "confirmed",
"created" : 1567949246
},
{
"id" : "r_MP4WdkOw32TSain2tjORQFD3KPikzWTp",
"db_id" : "15",
"serviceId" : "s_AO4WdkOw32XSyrn2tjORQFD4KPikzWTK",
"providerId" : 2
"customerId" : "c_AO4WdkOw32XSyrn2tjORQFD4KPikzWTK",
"start" : 1567949246
"end" : 1567949564,
"status" : "cancelled",
"created" : 1567949246
},
...
]
} Add Reservation
POST https://yourdomain.com/apibaseurl/reservations/add/
This endpoint allows you to create a reservation.
Request Body
200 Reservation record succesfully created.
Edit reservation
POST https://yourdomain.com/apibaseurl/reservations/edit/
This endpoint allows you to edit a reservation entry.
Request Body
200 Reservation record succesfully edited.
Remove reservation
POST https://yourdomain.com/apibaseurl/reservations/remove/
This endpoint allows you to remove a reservation from the database. The operation won't trigger any event down the line.
An error is returned if the reservation is confirmed or pending. If you need to remove a database record of a reservation which is confirmed or pending, edit it first.
Query Parameters
200 Reservation record succesfully deleted. 304 Reservation is confirmed or pending. 404 Reservation entry not found.
Services
Get Services
GET https://yourdomain.com/apibaseurl/services/get/
This endpoint allows you to get service entries.
Query Parameters
200 Services succesfully retrieved.
Copy {
"entries" : [
{
"type" : "service" ,
"id" : "music-class" ,
"name" : "Music Class" ,
"color" : "#81D742" ,
"class" : "appointment" ,
"description" : "Violin music class" ,
"isActive" : true ,
"bookable" : "everyone" ,
"location" : {
"setting" : "fixed" ,
"address" : "Empire State Building, 5th Avenue, New York"
} ,
"redirectURL" : "http://www.hello.com" ,
"notificationEmailAdmin" : {
"send" : true ,
"address" : "admin@example.com" ,
"subject" : "Just got a new reservation" ,
"body" : "<p>e-mail message body</p>"
} ,
"notificationEmailCustomer" : {
"send" : true ,
"subject" : "Just got a new reservation" ,
"body" : "<p>e-mail message body</p>"
} ,
"reminderEmail" : {
"send" : false ,
"subject" : "Don't forget your reservation" ,
"body" : "We are getting close!"
} ,
"cancellationByCustomer" : {
"allow" : false
}
"payments" : {
"fares" : {
"normal" : {
"name" : "Regular fare" ,
"desc" : "Regular fare" ,
"price" : 10
} ,
"fare_1" : {
"name" : "Super fare" ,
"desc" : "Super fare" ,
"price" : 14
}
} ,
"required" : "immediately"
} ,
"approval" : {
"requireFrom" : "admin" ,
"keepFreeUntilApproval" : false
}
}
]
}
Add Service
POST https://yourdomain.com/apibaseurl/services/add/
This endpoint allows you to create a service.
Request Body
200 Service record succesfully created.
Edit service
POST https://yourdomain.com/apibaseurl/services/edit/
This endpoint allows you to edit a service entry.
Request Body
200 Service record succesfully edited.
Remove service
POST https://yourdomain.com/apibaseurl/services/remove/
This endpoint allows you to remove a service from the database.
An error is returned if there are reservations in place for the service.
Query Parameters
200: OK Service record succesfully deleted. 403: Forbidden There are reservations for the service. 404: Not Found Service entry not found.
Providers
Get Providers
GET https://yourdomain.com/apibaseurl/providers/get/
This endpoint allows you to get providers entries.
200 Providers succesfully retrieved.
Copy {
"entries" : [
{
"type" : "service" ,
"id" : "music-class" ,
"name" : "Music Class" ,
"color" : "#81D742" ,
"class" : "appointment" ,
"description" : "Violin music class" ,
"isActive" : true ,
"bookable" : "everyone" ,
"location" : {
"setting" : "fixed" ,
"address" : "Empire State Building, 5th Avenue, New York"
} ,
"redirectURL" : "http://www.hello.com" ,
"notificationEmailAdmin" : {
"send" : true ,
"address" : "admin@example.com" ,
"subject" : "Just got a new reservation" ,
"body" : "<p>e-mail message body</p>"
} ,
"notificationEmailCustomer" : {
"send" : true ,
"subject" : "Just got a new reservation" ,
"body" : "<p>e-mail message body</p>"
} ,
"reminderEmail" : {
"send" : false ,
"subject" : "Don't forget your reservation" ,
"body" : "We are getting close!"
} ,
"cancellationByCustomer" : {
"allow" : false
}
"payments" : {
"fares" : {
"normal" : {
"name" : "Regular fare" ,
"desc" : "Regular fare" ,
"price" : 10
} ,
"fare_1" : {
"name" : "Super fare" ,
"desc" : "Super fare" ,
"price" : 14
}
} ,
"required" : "immediately"
} ,
"approval" : {
"requireFrom" : "admin" ,
"keepFreeUntilApproval" : false
}
}
]
}
Edit Provider
POST https://yourdomain.com/apibaseurl/providers/edit/
This endpoint allows you to edit a provider entry.
Request Body
200: OK Provider record succesfully edited.
Edit Provider Service settings
POST https://yourdomain.com/apibaseurl/providers/edit/service/
This endpoint allows you to edit provider service settings.
Query Parameters
Request Body
200: OK Provider service settings succesfully edited.
Customers
Get Customers
GET https://yourdomain.com/apibaseurl/customers/get/
This endpoint allows you to get customers entries.
200 Customers succesfully retrieved.
Copy {
"entries" : [
{
"type" : "service" ,
"id" : "music-class" ,
"name" : "Music Class" ,
"color" : "#81D742" ,
"class" : "appointment" ,
"description" : "Violin music class" ,
"isActive" : true ,
"bookable" : "everyone" ,
"location" : {
"setting" : "fixed" ,
"address" : "Empire State Building, 5th Avenue, New York"
} ,
"redirectURL" : "http://www.hello.com" ,
"notificationEmailAdmin" : {
"send" : true ,
"address" : "admin@example.com" ,
"subject" : "Just got a new reservation" ,
"body" : "<p>e-mail message body</p>"
} ,
"notificationEmailCustomer" : {
"send" : true ,
"subject" : "Just got a new reservation" ,
"body" : "<p>e-mail message body</p>"
} ,
"reminderEmail" : {
"send" : false ,
"subject" : "Don't forget your reservation" ,
"body" : "We are getting close!"
} ,
"cancellationByCustomer" : {
"allow" : false
}
"payments" : {
"fares" : {
"normal" : {
"name" : "Regular fare" ,
"desc" : "Regular fare" ,
"price" : 10
} ,
"fare_1" : {
"name" : "Super fare" ,
"desc" : "Super fare" ,
"price" : 14
}
} ,
"required" : "immediately"
} ,
"approval" : {
"requireFrom" : "admin" ,
"keepFreeUntilApproval" : false
}
}
]
}
Add Customer
POST https://yourdomain.com/apibaseurl/customers/add/
This endpoint allows you to create a customer.
Query Parameters
Request Body
201: Created Customer record succesfully created. ID of the new customer is returned.
Copy {
"id" : "c_XXXXXXXXXXX"
} Edit Customer
POST https://yourdomain.com/apibaseurl/customer/edit/
This endpoint allows you to edit a customer entry.
Request Body
200 Customer record succesfully edited.
Remove Customer
POST https://yourdomain.com/apibaseurl/customers/remove/
This endpoint allows you to remove a customer from the database.
An error is returned if there are reservations in place for the customer.
Query Parameters
200: OK Customer record succesfully deleted. 403: Forbidden There are reservations for the customer. 404: Not Found Customer not found.
Availability
Get Availability
GET https://yourdomain.com/apibaseurl/availability/get/
This endpoint allows you to get timeslot entries (services of Unscheduled type are excluded).
Query Parameters
200: OK Succesful response.
Copy "entries" : [
{
"serviceId" : "music-class" ,
"start" : 1568253600 ,
"end" : 1568257200 ,
"providerId" : 1 ,
"isFull" : false ,
"isAllday" : false ,
"location" : "Empire State Building, 5th Avenue, New York" ,
"timezone" : "America/New_York" ,
"fares" : {
"normal" : 10 ,
"fare_1" : 14
} ,
"max_tickets" : 6 ,
"bookableUntil" : 1568250000 ,
"readOnly" : false ,
"paddingAfter" : 0
}
]