Onsched

OnSched Consumer API

Build secure and scalable custom apps for Online Booking. Our flexible API provides many options for availability and booking. Take the API for a test drive.…

Developer tools#openapi#collaboration

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Build secure and scalable custom apps for Online Booking. Our flexible API provides many options for availability and booking.

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.

The API has two interfaces, consumer and setup.

The consumer interface provides all the endpoints required for implementing consumer booking flows.

The setup interface provides endpoints for profile configuration and setup.

Toggle freely between the two interfaces using the swagger tool bar option labelled 'Select a definition'.

Endpoints 38

Appointments

  • GETGet Appointments/consumer/v1/appointments?locationId=string&email=string&lastname=string&phone=string&serviceId=string&calendarId=string&resourceId=string&customerId=string&serviceAllocationId=string&startDate=2024-01-01T00:00:00Z&endDate=2024-01-01T00:00:00Z&status=string&bookedBy=string&offset=0&limit=0<p>Use this endpoint to return a <b>List of Appointments</b>. Use the offset and limit parameters to control the page start and number of results. Default…
  • POSTCreate Appointment/consumer/v1/appointments?completeBooking=string<p>Use this endpoint to <b>Create</b> a new appointment. The appointment will be created with an "IN", Initial status. Posting an appointment with "IN" status…
  • GETGet Custom Fields Labels/consumer/v1/appointments/bookingfields?locationId=string<p>Use this endpoint to return a locations <b>Appointment Booking Fields</b>. Appointment booking fields are stored with each Appointment record. They are…
  • GETGet Custom Fields List/consumer/v1/appointments/customfields?locationId=string<p>Use this endpoint to return a locations <b>Appointment Custom Field</b> definitions. Appointment custom fields are stored with each appointment. They are…
  • GETGet Appointment/consumer/v1/appointments/:id<p>Use this endpoint to return an <b>Appointment</b> object. A valid <b>appointment id</b> is required. For more information: <a…
  • DELETEDelete Appointment/consumer/v1/appointments/:id<p>Use this endpoint to permanently <b>Delete</b> an appointment. Only appointments with a of "IN" status, initial, can be deleted. Past dated appointments…
  • PUTBook Appointment/consumer/v1/appointments/:id/book<p>Use this endpoint to <b>Book</b> an appointment. Only appointments with an "IN" status, Initial, can be booked. A valid <b>appointment id</b> is required.…
  • PUTCancel Appointment/consumer/v1/appointments/:id/cancel<p>Use this endpoint to <b>Cancel</b> an appointment booking or reservation. Only appointments with a "BK", booked or "RS", reserved status can be cancelled.…
  • PUTConfirm Appointment/consumer/v1/appointments/:id/confirm?undo=true<p>Use this endpoint to <b>Confirm</b> an appointment. This updates the boolean confirmed field to TRUE. <b>NOTE:</b> If the appointment status is set to…
  • PUTSet NoShow Status/consumer/v1/appointments/:id/noshow<p>Use this endpoint to change the status of an appointment from "BK", Booked to <b>"NS", NoShow</b>. This gives API consumers a way to internally track No…
  • PUTReschedule Appointment/consumer/v1/appointments/:id/reschedule<p>Use this endpoint to <b>Reschedule</b> an appointment booking. Only appointments in "BK", booked status, can be Rescheduled. Past dated appointments cannot…
  • PUTReserve Appointment/consumer/v1/appointments/:id/reserve?sendNotifications=true<p>Use this endpoint to <b>Reserve</b> an appointment. Only appointments with an "IN" status, Initial, can be reserved. A valid <b>appointment id</b> is…

Availability

  • GETGet Available Times/consumer/v1/availability/:serviceId/:startDate/:endDate?startTime=0&endTime=0&locationId=string&resourceId=string&resourceGroupId=string&resourceIds=string&roundRobin=string&duration=0&interval=0&timezoneName=string&tzOffset=0&destination=string&dayAvailabilityStartDate=2024-01-01T00:00:00Z&dayAvailability=0&firstDayAvailable=true<p> <b>Choose your search criteria carefully. Availability is an expensive call.</b> If you search availability for all resources, you should only do so for a…
  • GETGet Available Days/consumer/v1/availability/:serviceId/:startDate/:endDate/days?locationId=string&resourceId=string&tzOffset=0<p>This endpoint will return <b>Day Level Availability</b> for the range of dates requested. For example, if the business is closed, or there is a public…
  • GETGet Unavailable Times/consumer/v1/availability/:serviceId/:startDate/:endDate/unavailable?locationId=string&resourceId=string&duration=0&tzOffset=0&skipTimePastUnavailability=true<p>This endpoint is used to show <b>Unavailable</b> times and provides valuable information as to why a time slot is unavailable. If you question your…

Customers

  • GETList Customers/consumer/v1/customers?locationId=string&groupId=string&email=string&lastname=string&deleted=true&offset=0&limit=0<p>Use this endpoint to return a <b>List of Customers</b>. The results are returned in pages. Use the offset and limit parameters to control the page start…
  • POSTCreate Customer/consumer/v1/customers<p>Use this endpoint to <b>Create</b> a new Customer. A customer object is automatically created with the first appointment booking if it doesn't already…
  • GETGet Customer Booking Fields/consumer/v1/customers/bookingfields?locationId=string<p>Use this endpoint to return <b>Customer Booking Fields</b>. Customer booking fields are stored with each customer object. They are used when the…
  • GETList Country Codes/consumer/v1/customers/countries<p>Use this endpoint to return a <b>List of Countries with their associated Country Code</b>. Country codes are based on the 2-character ANSI standard. If…
  • GETGet Customer Custom Fields/consumer/v1/customers/customfields?locationId=string&leadQuestions=true<p>Use this endpoint to return <b>Customer Custom Fields</b>. Customer custom fields are stored with the customer object. They are used when the information…
  • GETList Country States/consumer/v1/customers/states?country=string<p>Use this endpoint to return a <b>List of Countries with their associated State Codes</b>. Supply a country code to filter results further. If states for…
  • GETGet Customer/consumer/v1/customers/:id<p>Use this endpoint to return a <b>Customer</b> object. A valid <b>customer id</b> is required. Find customer id's by using the <i>GET…
  • PUTUpdate Customer/consumer/v1/customers/:id<p>Use this endpoint to <b>Update</b> a Customer object. A valid <b>customer id</b> is required. Note: Blank fields are not changed.</p>
  • DELETEDelete Customer/consumer/v1/customers/:id<p>Use this endpoint to permanently <b>Delete</b> a Customer object. A valid <b>customer id</b> is required.</p>

Locations

  • GETList Locations/consumer/v1/locations?name=string&nearestTo=string&proximity=0&units=string&serviceId=string&friendlyId=string&regionId=string&ignorePrimary=true&offset=0&limit=0<p>Use this endpoint to return a <b>List of Business Locations</b>. The results are returned in pages. Use the offset and limit parameters to control the page…
  • GETGet Location/consumer/v1/locations/:id<p>Use this endpoint to return a <b>Location</b> object. A valid business <b>location id</b> is required. Find all location id's by using the <i>GET…

ResourceGroups

  • GETList Resource Groups/consumer/v1/resourcegroups?locationId=string&deleted=true&offset=0&limit=0<p>Use this endpoint to return a list of <b>Resource Groups</b> for the requested location. If not specified, the business location defaults to the primary…
  • GETGet Resource Group/consumer/v1/resourcegroups/:id<p>Use this endpoint to return a <b>Resource Group</b> object. A valid <b>resourceGroup id</b> is required. Find resourceGroup id's by using the <i>GET…

Resources

  • GETList Resources/consumer/v1/resources?locationId=string&resourceGroupId=0&email=string&name=string&sortOrder=string&offset=0&limit=0<p>Use this endpoint to return a <b>List of Resources</b> associated with a business location. If not specified, the business location defaults to the primary…
  • GETGet Resource/consumer/v1/resources/:id<p>Use this endpoint to return a <b>Resource</b> object. A valid <b>resource id</b> is required. Find resource id's by using the <i>GET…
  • GETGet Resource Linked Services/consumer/v1/resources/:id/services?offset=0&limit=0<p>Use this endpoint to get a <b>List of Linked Services</b> associated with the resource requested. The results are returned in pages. Use the offset and…

ServiceGroups

  • GETList Service Groups/consumer/v1/servicegroups?locationId=string&offset=0&limit=0<p>Use this endpoint to return a list of <b>Service Groups</b> for the requested location. If not specified, the business location defaults to the primary…
  • GETGet Service Group/consumer/v1/servicegroups/:id<p>Use this endpoint to return a <b>Service Group</b> object. A valid <b>serviceGroup id</b> is required. Find serviceGroup id's by using the <i>GET…

Services

  • GETList Services/consumer/v1/services?locationId=string&serviceGroupId=0&defaultService=true&allLocations=true&scope=company&name=string&serviceId=string&offset=0&limit=0&sortOrder=natural&sortDescending=true<p>Use this endpoint to <b>List Services</b> available at your business location and/or company. If not specified, the business location defaults to the…
  • GETGet Service Allocation/consumer/v1/services/allocations/:id<p>Use this endpoint to return a <b>Service Allocation</b> object. A valid <b>serviceAllocation id</b> is required. Find service allocation id's by using the…
  • GETGet Service/consumer/v1/services/:id<p>Use this endpoint to return a <b>Service</b> object. A valid <b>service id</b> is required. Find service id's by using the <i>GET /consumer/v1/services</i>…
  • GETList Service Allocations/consumer/v1/services/:id/allocations?locationId=string&resourceId=string&startDate=2024-01-01T00:00:00Z&endDate=2024-01-01T00:00:00Z&offset=0&limit=0<p>Use this endpoint to return a <b>List of Service Allocations</b> associated with the requested service. A valid <b>service id</b> is required. Allocations…
  • GETList Resources for Service/consumer/v1/services/:id/resources?locationId=string&offset=0&limit=0<p>Use this endpoint to return a list of <b>Resources that provide the Service requested</b>. A valid <b>service id</b> is required. The results are returned…

API details

Base URL
https://sandbox-api.onsched.com
Authentication
OAuth 2.0 (client credentials flow) with 2 scopes
Operations
38 operations on 33 pathsGET 27PUT 7POST 2DELETE 2
Main resources
Appointments 12Customers 9Services 5Availability 3Resources 3Locations 2ResourceGroups 2ServiceGroups 2
Response formats
application/json
Description format
OpenAPI 3.0.1, API version v1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the OnSched Consumer API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the OnSched Consumer API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (client credentials flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get Appointments” (GET /consumer/v1/appointments?locationId=string&email=string&lastname=string&phone=string&serviceId=string&calendarId=string&resourceId=string&customerId=string&serviceAllocationId=string&startDate=2024-01-01T00:00:00Z&endDate=2024-01-01T00:00:00Z&status=string&bookedBy=string&offset=0&limit=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the OnSched Consumer API?

Build secure and scalable custom apps for Online Booking. Our flexible API provides many options for availability and booking. Take the API for a test drive.… It is listed under Developer tools and has 38 endpoints.

Who publishes the OnSched Consumer API?

It is listed from Onsched's public API description (an OpenAPI document), not published by Onsched on Swastik Codes. Anyone who controls onsched.com can claim the profile by adding a DNS TXT record.

What is the base URL of the OnSched Consumer API?

Requests go to https://sandbox-api.onsched.com. Endpoint paths are added to this base URL.

How do I authenticate with the OnSched Consumer API?

With OAuth 2.0 (client credentials flow) with 2 scopes.

How many endpoints does the OnSched Consumer API have?

38 operations on 33 paths (27 GET, 7 PUT, 2 POST, 2 DELETE). The largest groups are Appointments, Customers, Services, Availability.

Is forking the OnSched Consumer API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.