Methods
Reservations
Get Reservations
GET
https://yourdomain.com/apibaseurl/reservations/get/
Get reservation entries.
Query Parameters
past
Boolean
If TRUE, returned entries will include past reservations. Default is FALSE.
providers
String
Comma-separated Provider IDs.
services
String
Comma-separated Service IDs.
customers
String
Comma-separated Customer IDs.
status
String
Status of the requsted reservations. Possible values are "pending", "confirmed", "cancelled".
full
Boolean
If TRUE, returned entries will include all the metadata. Default is FALSE.
Headers
Authentication*
String
Authentication token (Bearer)
Add Reservation
POST
https://yourdomain.com/apibaseurl/reservations/add/
This endpoint allows you to create a reservation.
Headers
Authentication*
String
Authentication token (Bearer). It must allow write operations.
Request Body
reservation*
Object
The reservation object that needs to be created.
Edit reservation
POST
https://yourdomain.com/apibaseurl/reservations/edit/
This endpoint allows you to edit a reservation entry.
Headers
Authentication*
String
Authentication token (Bearer). It must allow write operations.
Request Body
reservation*
Object
The edited reservation object (can be partial, but it must contain the ID at least, otherwise an error is returned).
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
id*
String
ID of the reservation that needs to be deleted.
Headers
Authentication*
String
Authentication token (Bearer). It must allow write operations, otherwise an error is returned.
Services
Get Services
GET
https://yourdomain.com/apibaseurl/services/get/
This endpoint allows you to get service entries.
Query Parameters
full
Boolean
If TRUE, the entries will include all the metadata. Default is FALSE.
Headers
Authentication*
String
Authentication token (Bearer)
Add Service
POST
https://yourdomain.com/apibaseurl/services/add/
This endpoint allows you to create a service.
Headers
Authentication*
String
Authentication token (Bearer). It must allow write operations.
Request Body
service*
Object
The service object that needs to be created.
Edit service
POST
https://yourdomain.com/apibaseurl/services/edit/
This endpoint allows you to edit a service entry.
Headers
Authentication*
String
Authentication token (Bearer). It must allow write operations.
Request Body
service*
Object
The edited service object (can be partial, but it must contain the ID at least, otherwise an error is returned).
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
id*
String
ID of the service that needs to be deleted.
Headers
Authentication*
String
Authentication token (Bearer). It must allow write operations, otherwise an error is returned.
Providers
Get Providers
GET
https://yourdomain.com/apibaseurl/providers/get/
This endpoint allows you to get providers entries.
Headers
Authentication*
String
Authentication token (Bearer)
Edit Provider
POST
https://yourdomain.com/apibaseurl/providers/edit/
This endpoint allows you to edit a provider entry.
Headers
Authentication*
String
Authentication token (Bearer). It must allow write operations.
Request Body
provider*
Object
The edited provider object (can be partial, but it must contain the ID at least, otherwise an error is returned).
Edit Provider Service settings
POST
https://yourdomain.com/apibaseurl/providers/edit/service/
This endpoint allows you to edit provider service settings.
Query Parameters
serviceId*
String
The ID of the service
providerId
String
The ID of the provider
Headers
Authentication*
String
Authentication token (Bearer). It must allow write operations.
Request Body
settings*
Object
The edited provider service settings object (can be partial).
Customers
Get Customers
GET
https://yourdomain.com/apibaseurl/customers/get/
This endpoint allows you to get customers entries.
Headers
Authentication*
String
Authentication token (Bearer)
Add Customer
POST
https://yourdomain.com/apibaseurl/customers/add/
This endpoint allows you to create a customer.
Query Parameters
createUser
Boolean
If TRUE, a WordPress user will be created as well. Default is FALSE.
Headers
Authentication*
String
Authentication token (Bearer). It must allow write operations.
Request Body
customer*
Object
The customer object that needs to be created.
Edit Customer
POST
https://yourdomain.com/apibaseurl/customer/edit/
This endpoint allows you to edit a customer entry.
Headers
Authentication*
String
Authentication token (Bearer). It must allow write operations.
Request Body
customer*
Object
The edited customer object (can be partial, but it must contain the ID at least, otherwise an error is returned).
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
id*
String
ID of the customer that needs to be deleted.
Headers
Authentication*
String
Authentication token (Bearer). It must allow write operations.
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
max_timestamp*
Int
Unix time. The returned set will contain only timeslots that end before this time.
min_timestamp*
Int
Unix time. The returned set will contain only timeslots that start after this time.
services
String
Comma-separated Service IDs.
providers
String
Comma-separated Provider IDs.
Headers
Authentication*
string
Authentication token (Bearer)
Last updated