OnSched Setup API API

Overview

Build secure and scalable custom apps for onboarding and setup. Our flexible API provides many options for configuration. <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 Setup API is a documents & productivity API from onsched.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 138 endpoints.

At a glance

Authentication

OAuth

HTTPS

Yes

CORS

Unknown

Category

Documents & Productivity

Base URL

https://sandbox-api.onsched.com/

Version

v1

Endpoints

138

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/setup/v1/appointments" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://sandbox-api.onsched.com/setup/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/setup/v1/appointments",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

Questions