OnSched Consumer API

Build secure and scalable custom apps for Online Booking. Our flexible API provides many options for availability and booking. <br><br> Take the API for a test drive. Just click on the Authorize button below and authenticate. You can access our demo company profile if you are not a customer, or your own profile by using your assigned ClientId and Secret. <br><br> The API has two interfaces, consumer and setup. <ul> <li> The consumer interface provides all the endpoints required for implementing consumer booking flows. </li> <li> The setup interface provides endpoints for profile configuration and setup. </li> </ul> Toggle freely between the two interfaces using the swagger tool bar option labelled 'Select a definition'.

Claim this API

Are you the operator of OnSched Consumer API? Submit a claim to establish contact with us.

Report an Issue

Found something wrong with OnSched Consumer API? Let us know about broken links, changed auth, deprecated endpoints, or other issues.
Base URL: https://sandbox-api.onsched.com/
Auth: unknown
Endpoints: 18
Reachable: unknown
CORS: unknown

Endpoints

Method Path Summary Auth Last Status Latency
GET /consumer/v1/appointments Get Appointments — — —
GET /consumer/v1/appointments/bookingfields Get Custom Fields Labels — — —
GET /consumer/v1/appointments/customfields Get Custom Fields List — — —
GET /consumer/v1/appointments/{id} Get Appointment — — —
GET /consumer/v1/availability/{serviceId}/{startDate}/{endDate} Get Available Times — — —
GET /consumer/v1/availability/{serviceId}/{startDate}/{endDate}/days Get Available Days — — —
GET /consumer/v1/availability/{serviceId}/{startDate}/{endDate}/unavailable Get Unavailable Times — — —
GET /consumer/v1/customers List Customers — — —
GET /consumer/v1/customers/bookingfields Get Customer Booking Fields — — —
GET /consumer/v1/customers/countries List Country Codes — — —
GET /consumer/v1/customers/customfields Get Customer Custom Fields — — —
GET /consumer/v1/customers/states List Country States — — —
GET /consumer/v1/customers/{id} Get Customer — — —
GET /consumer/v1/locations List Locations — — —
GET /consumer/v1/locations/{id} Get Location — — —
GET /consumer/v1/resourcegroups List Resource Groups — — —
GET /consumer/v1/resourcegroups/{id} Get Resource Group — — —
GET /consumer/v1/resources List Resources — — —
GET /consumer/v1/resources/{id} Get Resource — — —
GET /consumer/v1/resources/{id}/services Get Resource Linked Services — — —
GET /consumer/v1/servicegroups List Service Groups — — —
GET /consumer/v1/servicegroups/{id} Get Service Group — — —
GET /consumer/v1/services List Services — — —
GET /consumer/v1/services/allocations/{id} Get Service Allocation — — —
GET /consumer/v1/services/{id} Get Service — — —
GET /consumer/v1/services/{id}/allocations List Service Allocations — — —
GET /consumer/v1/services/{id}/resources List Resources for Service — — —