GET
GetDynamicFieldsBookingLogs v2
GetChangeLogs
Retrieves all booking logs in the specified datetime range [changedSince, changedUntil).
Bookings (As of version 3)
GetServiceGroupBookingEligibility
Checks a service group's booking limitation settings and returns a user's eligibility to make a booking. Booking limitation settings for each service under the service group are not checked.
For now, there is only one service group booking limitation: (10023) Booking could not be made as the limit of upcoming booking is 1.
Timeslots v2
GetAvailability
Retrieves available timeslots for a service in a defined datetime range [startDate, endDate]. Availability count returned will be at least 1. Pending and accepted bookings count towards availability quota.
GetAvailabilityByDay
Retrieves availability of all service providers for a service, grouped by day Availability count returned may be zero. Pending and accepted bookings count towards availability quota.
GetTimeslots
Retrieves timeslots and service providers in a defined datetime range [startDate, endDate]. Pending and accepted bookings count towards availability quota, and the availability count may be returned as zero. Optionally returns bookings.
GetTimeslotCounts
Retrieves timeslot availability and capacity counts, as well as number of bookings, across ALL service providers in a defined datetime range [startDate, endDate]. Pending and accepted bookings count towards availability quota, and the availability count may be returned as zero.
Organisations v2
Settings v1
Services v2
Service Notification Template v2
GetEmailNotificationTemplate
Get a single email notification template of a service. If service template does not exist, then get the default template.
Encryption v1
Service Providers (As of version 3)
GetServiceProvidersWithAvailabilityCount
Retrieves a list service providers with their availability count. If the response does not contain "availabilityCount" parameter, it means that availability cannot be computed based on API query params and service settings AvailabilityCount is based on certain conditions.
GetAvailableServiceProvidersForEventSlot
Retrieves available service providers in the specified datetime range.
GetServiceProvidersByName
Retrieves service providers whose name contains the searchKey, mainly for autocomplete feature.
GetTimeslotsScheduleByServiceProviderId
Retrieves all weekly recurring timeslots for a service provider.
Users (As of version 2)
GetProfile
Returns information about the current user. It returns Unauthorized (401) status code if the user is not logged in.
Unavailabilities v2
Dynamic Fields v2
Events v2
GetAffectedEventBookings
Returns an array of bookings that will be affected by the update of event timeslot due to event booking limitation.
Attendees Fields v2
Service SMS Notification Template v2
GetSMSNotificationTemplate
Get a single sms notification template of a service. If service template does not exist, this will return the default template for that smsTemplateType
Service Group V2
GetServiceAvailabilities
Retrieves availability of services that belong to the service group. This API is different from the GET /serviceGroups and /serviceGroups/{serviceGroupId}. It requires different request input (date, postal code and label ids) and returns services' availabilities on top of what the other two GET API routes return.
Reports v2
Schemas
Last updated