Skip to content

OnSched Consumer API API

by onsched.com

Open documentation ↗

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
Base URL
https://sandbox-api.onsched.com/
Version
v1
Endpoints
38
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://sandbox-api.onsched.com/consumer/v1/appointments" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
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);
Python
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

MethodPathWhat it does
GET/consumer/v1/appointmentsGet Appointments
POST/consumer/v1/appointmentsCreate Appointment
GET/consumer/v1/appointments/bookingfieldsGet Custom Fields Labels
GET/consumer/v1/appointments/customfieldsGet Custom Fields List
GET/consumer/v1/appointments/{id}Get Appointment
DELETE/consumer/v1/appointments/{id}Delete Appointment
PUT/consumer/v1/appointments/{id}/bookBook Appointment
PUT/consumer/v1/appointments/{id}/cancelCancel Appointment
PUT/consumer/v1/appointments/{id}/confirmConfirm Appointment
PUT/consumer/v1/appointments/{id}/noshowSet NoShow Status
PUT/consumer/v1/appointments/{id}/rescheduleReschedule Appointment
PUT/consumer/v1/appointments/{id}/reserveReserve Appointment
GET/consumer/v1/availability/{serviceId}/{startDate}/{endDate}Get Available Times
GET/consumer/v1/availability/{serviceId}/{startDate}/{endDate}/daysGet Available Days
GET/consumer/v1/availability/{serviceId}/{startDate}/{endDate}/unavailableGet Unavailable Times
GET/consumer/v1/customersList Customers
POST/consumer/v1/customersCreate Customer
GET/consumer/v1/customers/bookingfieldsGet Customer Booking Fields
GET/consumer/v1/customers/countriesList Country Codes
GET/consumer/v1/customers/customfieldsGet Customer Custom Fields
GET/consumer/v1/customers/statesList 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/locationsList Locations
GET/consumer/v1/locations/{id}Get Location
GET/consumer/v1/resourcegroupsList Resource Groups
GET/consumer/v1/resourcegroups/{id}Get Resource Group
GET/consumer/v1/resourcesList Resources
GET/consumer/v1/resources/{id}Get Resource
GET/consumer/v1/resources/{id}/servicesGet Resource Linked Services
GET/consumer/v1/servicegroupsList Service Groups
GET/consumer/v1/servicegroups/{id}Get Service Group
GET/consumer/v1/servicesList Services
GET/consumer/v1/services/allocations/{id}Get Service Allocation
GET/consumer/v1/services/{id}Get Service
GET/consumer/v1/services/{id}/allocationsList Service Allocations
GET/consumer/v1/services/{id}/resourcesList 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.

Compare alternatives →

Listed from APIs.guru (CC0).