Welcome to the OnSched API version 3.0.0!

Welcome to the OnSched API. This API allows authenticated clients to interact with our backend services for appointment scheduling, user management, and other core platform features.

All requests must be made over HTTPS to ensure security and data privacy.

To get started use the left side navigation to locate an endpoint you wish to test.

Click Log In at the top right to sign in to your OnSched account, once signed in you will be redirected back to the API with the Credentials section pre-filled using the keys from your OnSched Company.

Once your credentials have been added, click the "Try It!" button to make a request with the data entered on the page under Path and Body Params.

To adjust the environment from "Staging" to "Production" once you are ready to go live, simply select the environment you wish to test by clicking on the "Base URL" dropdown.

All requests made within the documentation will be logged internally for support purposes. If you encounter errors when testing in the API please contact our support team by filling selecting the chat bubble at the bottom right of the page and filling out a support ticket form. We will be able to trace the logs of your test API calls and assist in troubleshooting.