Overview
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'.
OnSched Consumer API is a documents & productivity API from onsched.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 38 endpoints.
At a glance
- Authentication
- OAuth
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Documents & Productivity
- Base URL
https://sandbox-api.onsched.com/- Version
- v1
- Endpoints
- 38
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://sandbox-api.onsched.com/consumer/v1/appointments" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN"const response = await fetch("https://sandbox-api.onsched.com/consumer/v1/appointments", {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": "Bearer YOUR_TOKEN",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://sandbox-api.onsched.com/consumer/v1/appointments",
headers={
"Accept": "application/json",
"Authorization": "Bearer YOUR_TOKEN",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /consumer/v1/appointments | Get Appointments |
| POST | /consumer/v1/appointments | Create Appointment |
| 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 |
| DELETE | /consumer/v1/appointments/{id} | Delete Appointment |
| PUT | /consumer/v1/appointments/{id}/book | Book Appointment |
| PUT | /consumer/v1/appointments/{id}/cancel | Cancel Appointment |
| PUT | /consumer/v1/appointments/{id}/confirm | Confirm Appointment |
| PUT | /consumer/v1/appointments/{id}/noshow | Set NoShow Status |
| PUT | /consumer/v1/appointments/{id}/reschedule | Reschedule Appointment |
| PUT | /consumer/v1/appointments/{id}/reserve | Reserve 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 |
| POST | /consumer/v1/customers | Create Customer |
| 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 |
| PUT | /consumer/v1/customers/{id} | Update Customer |
| DELETE | /consumer/v1/customers/{id} | Delete 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 |
Questions
Does the OnSched Consumer API API need an API key?
Yes. The OnSched Consumer API API uses OAuth authentication; the documentation explains how to get credentials.
Does the OnSched Consumer API API support HTTPS?
Yes, the OnSched Consumer API API is served over HTTPS.
How many endpoints does the OnSched Consumer API API have?
Its OpenAPI description lists 38 endpoints in version v1. All of them are shown on this page.
What are alternatives to the OnSched Consumer API API?
Other Documents & Productivity APIs include JIRA, Notion, DocStruct, Asana, ClickUp.
Similar documents & productivity APIs
Compare alternatives →JIRA
Documents & ProductivityJIRA is a proprietary issue tracking product that allows bug tracking and agile project management
Notion
Documents & ProductivityIntegrate with Notion
DocStruct
Documents & ProductivityAI extraction of invoices, receipts, bank statements & contracts into structured JSON/CSV
Asana
Documents & ProductivityProgrammatic access to all data in your asana system
ClickUp
Documents & ProductivityClickUp is a robust, cloud-based project management tool for boosting productivity
iLovePDF
Documents & ProductivityConvert, merge, split, extract text and add page numbers for PDFs. Free for 250 documents/month
Listed from APIs.guru (CC0).