OnSched API Utility API

by onsched.com

Overview

Endpoints for system utilities. e.g.Health

OnSched API Utility is a documents & productivity API from onsched.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 2 endpoints.

At a glance

Authentication: OAuth
HTTPS: Yes
CORS: Unknown
Category: Documents & Productivity
Base URL: https://sandbox-api.onsched.com/
Version: v1
Endpoints: 2
OpenAPI: Specification ↗
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/utility/v1/health/heartbeat" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

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