OnSched Setup API
Build secure and scalable custom apps for onboarding and setup. Our flexible API provides many options for configuration. Take the API for a test drive. Just…
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 onboarding and setup. Our flexible API provides many options for configuration.
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 138
Appointments
- GETList Appointments
/setup/v1/appointments?locationId=string&email=string&lastname=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… - GETGet Appointment
/setup/v1/appointments/:id<p>Use this endpoint to return an <b>Appointment</b> object. A valid <b>appointment id</b> is required. Find appointment id's by using the… - PUTReassign Appointment
/setup/v1/appointments/:id/reassign/resource/:resourceId<p>Use this endpoint to <b>Reassign</b> an appointment from one resource to another. The result returned is a single appointment that was reassigned to the…
BusinessUsers
- GETList Users
/setup/v1/businessusers?locationId=string&email=string&role=string&offset=0&limit=0<p>Use this endpoint to return a <b>List of Business Users and their Roles</b>. The results are returned in pages. Use the offset and limit parameters to… - POSTCreate User
/setup/v1/businessusers<p>Use this endpoint to <b>Create</b> a Business User. If not specified, the business location defaults to the primary business location. </p> <p>Required… - GETList User Permissions
/setup/v1/businessusers/permissions?role=string&offset=0&limit=0<p>Use this endpoint to return a <b>List of Business User Permissions by Role</b>. Results are returned in pages. Use the offset and limit parameters to… - GETList User Companies
/setup/v1/businessusers/:email/companies?searchText=string&offset=0&limit=0<p>Use this endpoint to return a <b>List of Companies</b> associated with the business users email requested. A business user <b>email</b> address is… - GETGet User
/setup/v1/businessusers/:id<p>Use this endpoint to return a <b>Business User</b> object. A valid <b>businessUser id</b> is required. Find businessUser id's using the <i>GET… - PUTUpdate User
/setup/v1/businessusers/:id<p>Use this endpoint to <b>Update</b> a Business User. A valid <b>businessUser id</b> is required.</p> <p> <b>Business Roles Include: bizowner</b> (Business… - DELETEDelete User
/setup/v1/businessusers/:id<p>Use this endpoint to permanently <b>Delete</b> a Business User. A valid <b>businessUser id</b> is required.</p>
Calendars
- GETList Calendars
/setup/v1/calendars?locationId=string&deleted=true&offset=0&limit=0<p>Use this endpoint to return a <b>List of Calendars</b> from the requested location. If not specified, the business location defaults to the primary… - POSTDEPRECATING: Create
/setup/v1/calendars<p> <b>DEPRECATING:</b> Create Calendar</p> <p>We are no longer supporting Multiple Calendar Functionality as it is part of our Legacy Application and has no… - PUTUpdate Calendar Block
/setup/v1/calendars/block/:id<p>Use this endpoint to <b>Create</b> a Calendar Block. A valid <b>calendarBlock id</b> is required. Refer to the <i>POST… - DELETEDelete Calendar Block
/setup/v1/calendars/block/:id<p>Use this endpoint to permanently <b>Delete</b> a calendar block. A valid <b>calendarBlock id</b> is required.</p> - GETGet Calendar Block
/setup/v1/calendars/blocks/:id<p>Use this endpoint to return a <b>Calendar Block</b>. A valid <b>calendarBlock id</b> is required. </p> - GETGet Calendar
/setup/v1/calendars/:id<p>Use this endpoint to return a <b>Calendar</b> object. A valid <b>calendar id</b> is required.</p> - PUTUpdate Calendar
/setup/v1/calendars/:id<p>Use this endpoint to <b>Update</b> a calendar object. A valid <b>calendar id</b> is required. When your company was created a calendar object was… - DELETEDelete Calendar
/setup/v1/calendars/:id<p>Use this endpoint to <b>Delete</b> a calendar object. A valid <b>calendar id</b> is required. The calendar is not permanently deleted and can be recovered… - POSTCreate Calendar Block
/setup/v1/calendars/:id/block<p>Use this endpoint to <b>Create</b> a Calendar Block. A valid <b>calendar id</b> is required.</p> <p>Required fields: <b>startDate, endDate, startTime,… - GETList Calendar Blocks
/setup/v1/calendars/:id/blocks?offset=0&limit=0<p>Use this endpoint to return a <b>List of Calendar Blocks</b> for the requested calendar. A valid <b>calendar id</b> is required. </p> - PUTRecover Calendar
/setup/v1/calendars/:id/recover<p>Use this endpoint to <b>Recover</b> a previously deleted calendar object. A valid <b>calendar id</b> is required.</p> - GETList Calendar Services
/setup/v1/calendars/:id/services?offset=0&limit=0<p>Use this endpoint to return a <b>List of Linked Services</b> of a calendar object. A valid <b>calendar id</b> is required. Find calendar id's by using the…
Companies
- GETGet Company
/setup/v1/companies<p>Use this endpoint to return the <b>Authorized Company</b> information. The company is the main entity that oversees all business locations defined below… - PUTUpdate Company
/setup/v1/companies<p>Use this endpoint to <b>Update</b> the authorized company information. Your client credentials resolve to a single company. The timezoneName must be… - POSTCreate Company
/setup/v1/companies<p>Use this endpoint to <b>Create</b> a new authorized company.</p> <p> <b>Note: Special API Partner credentials are required to access this endpoint.</b>… - GETList Company Domains
/setup/v1/companies/domains<p>Use this endpoint to return a <b>List of Company Domains</b> for the authorized company. To share the OnSchedJS booking widget on your website or in your… - POSTCreate Company Domain
/setup/v1/companies/domains<p>Use this endpoint to <b>Create</b> an OnSchedJs domain for your authorized company. To share the OnSchedJS booking widget on your website or in your… - GETGet Company Domain
/setup/v1/companies/domains/:id<p>Use this endpoint to return a <b>Company Domain</b> object. A valid <b>companyDomain id</b> is required. </p> - PUTUpdate Company Domain
/setup/v1/companies/domains/:id<p>Use this endpoint to <b>Update</b> an OnSchedJs domain for your authorized company. A valid <b>companyDomain id</b> is required.</p> - DELETEDelete Company Domain
/setup/v1/companies/domains/:id<p>Use this endpoint to <b>Delete</b> an OnSchedJs domain from your authorized company. A valid <b>companyDomain id</b> is required.</p> - GETList Email Templates
/setup/v1/companies/email/templates<p>Use this endpoint to return a <b>List of Email Templates</b> that are provided and may be customized. If the template has been customized, the customized… - GETGet Master Template Settings
/setup/v1/companies/email/templates/master<p>Use this endpoint to return the <b>Master Email Template Settings</b>. Settings exist for showing or hiding email panels and for changing color schemes. </p> - POSTCreate Master Template Settings
/setup/v1/companies/email/templates/master<p>Use this endpoint to <b>Create Custom Master Email Template Settings</b>. Settings exist for showing or hiding email panels and for changing color schemes.… - DELETEDelete Master Template Settings
/setup/v1/companies/email/templates/master<p>Use this endpoint to <b>Delete Custom Master Email Template Settings</b>. Deleting a custom master email template setting will reactivate the original… - GETGet Email Template
/setup/v1/companies/email/templates/:templateName<p>Use this endpoint to return the requested <b>Email Template</b>. If it wasn't customized the default template is returned. The response content is in html… - GETList Regions
/setup/v1/companies/regions?offset=0&limit=0<p>Use this endpoint to return a list of <b>Regions</b> in the authorized company. The results are returned in pages. Use the offset and limit parameters to… - POSTCreate Region
/setup/v1/companies/regions<p>Use this endpoint to <b>Create</b> a region object. Regions can be mapped to business locations. They can be used by the locations endpoints to filter… - GETGet Region
/setup/v1/companies/regions/:id<p>Use this endpoint to return a <b>Region</b> object. A valid <b>region id</b> is required.</p> - PUTUpdate Region
/setup/v1/companies/regions/:id<p>Use this endpoint to <b>Update</b> a region object. A valid <b>region id</b> is required.</p> - DELETEDelete Region
/setup/v1/companies/regions/:id<p>Use this endpoint to <b>Delete</b> a region object. A valid <b>region id</b> is required. If the region is related to any business locations it won't be… - GETList Time Zones
/setup/v1/companies/timezones/:date<p>Use this endpoint to return a <b>List of timezone names, timezoneIana and tzOffset values</b> calculated for the date requested. Daylight Savings may or…
Customers
- GETList Customers
/setup/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… - GETGet Customer
/setup/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… - GETGet Customer Data
/setup/v1/customers/:id/privacy<p>Use this endpoint to return the <b>Customer</b> object. A valid <b>customer id</b> is required. Find customer id's using the <i>GET /setup/v1/customers</i>…
Locations
- GETList Locations
/setup/v1/locations?name=string&serviceId=string&friendlyId=string&deleted=true&offset=0&limit=0<p>Use this endpoint to <b>List Business Locations</b> associated with your company. The results are returned in pages. Use the offset and limit parameters to… - POSTCreate Location
/setup/v1/locations<p>Use this endpoint to <b>Create</b> a new business location. The result is a business location object with a GUID assigned to the location.</p> <p>The… - POSTCreate Locations Bulk
/setup/v1/locations/bulk<p>Use this endpoint to <b>Create Bulk</b> business locations. The posted list of locations cannot exceed 100 location objects per transaction for performance… - GETGet Linked Service
/setup/v1/locations/services/:id<p>Use this endpoint to <b>Get a Linked Service</b>. A valid <b>locationService id</b> is required.</p> - DELETEUnlink Service
/setup/v1/locations/services/:id<p>Use this endpoint to <b>Unlink</b> a location service from a business location. A valid <b>locationService id</b> is required. Find location services by… - GETGet Location
/setup/v1/locations/:id<p>Use this endpoint to return a <b>Location</b> object. A valid <b>location id</b> is required. If not specified, the business location defaults to the… - PUTUpdate Location
/setup/v1/locations/:id?removeRegion=true<p>Use this endpoint to <b>Update</b> a business location object. A valid business <b>location id</b> is required. The optional removeRegion query parameter… - DELETEDelete Location
/setup/v1/locations/:id<p>Use this endpoint to <b>Delete</b> a business location. A valid business <b>location id</b> is required. The location is not permanently deleted and can be… - GETGet Reminders
/setup/v1/locations/:id/appointmentreminders<p>Use this endpoint to <b>Get Email and SMS appointment reminder settings</b> for the requested location. A valid business <b>location id</b> is required. </p> - PUTUpdate Reminders
/setup/v1/locations/:id/appointmentreminders<p>Use this endpoint to <b>Update</b> Email and SMS appointment reminder settings for the requested location. A valid business <b>location id</b> is required.… - DELETEDelete All Location Images
/setup/v1/locations/:id/deleteallimages?uppercase=true<p>Use this endpoint to <b>Delete All</b> location images from the location blob storage container. An option exists to use upper case for matching the… - DELETEDelete Location Image
/setup/v1/locations/:id/deleteimage<p>Use this endpoint to <b>Delete</b> a previously uploaded location image. A valid business <b>location id</b> is required.</p> - GETList Email Templates
/setup/v1/locations/:id/email/templates<p>Use this endpoint to return a <b>List of Email Templates</b> that are provided and may be customized. If the template has been customized, the customized… - POSTCreate Custom Template
/setup/v1/locations/:id/email/templates<p>Use this endpoint to a <b>Create</b> a Custom Email Template. You must convert the content to a base64 encoded string. Updates to the primary business… - GETGet Master Template Settings
/setup/v1/locations/:id/email/templates/master<p>Use this endpoint to get <b>Master Email Template Settings</b>. A valid business <b>location id</b> is required. Settings exist for showing or hiding… - POSTCreate Master Template Settings
/setup/v1/locations/:id/email/templates/master<p>Use this endpoint to <b>Create Custom Master Email Template Settings</b>. A valid business <b>location id</b> is required. Settings exist for showing or… - DELETEDelete Master Template Settings
/setup/v1/locations/:id/email/templates/master<p>Use this endpoint to <b>Delete Custom Master Email Template Settings</b>. A valid business <b>location id</b> is required. Deleting a custom master email… - GETGet Email Template
/setup/v1/locations/:id/email/templates/:templateName<p>Use this endpoint to return the requested <b>Email Template</b>. The template is from the primary business location. If it wasn't customized the default… - DELETEDelete Custom Template
/setup/v1/locations/:id/email/templates/:templateName<p>Use this endpoint to <b>Delete</b> a Custom Email Template that was previously created. A valid business <b>location id</b> and email <b>templateName</b>… - POSTCreate Google Cal Access
/setup/v1/locations/:id/google/service/account<p>Use this endpoint to <b>Authorize Access</b> to google calendar users in your organization. You must create/have a Google Service account as an admin of… - DELETEDelete Google Cal Access
/setup/v1/locations/:id/google/service/account<p>Use this endpoint to <b>Delete</b> authorized access to all google calendar users in your organization. Upon deletion Google Calendars will no longer be… - PUTUpdate Location Holidays
/setup/v1/locations/:id/holidays/:holidayId/:closed<p>Use this endpoint to <b>Update</b> Business Holidays as Opened or Closed. A valid business <b>location id</b> is required. If not specified, the business… - PUTRecover Location
/setup/v1/locations/:id/recover<p>Use this endpoint to <b>Recover</b> a deleted business location. A valid business <b>location id</b> is required.</p> - GETList Location Linked Services
/setup/v1/locations/:id/services?offset=0&limit=0<p>Use this endpoint to return a list of <b>Location Linked Services</b>. A valid business <b>location id</b> is required. By default, there are no location… - POSTCreate Linked Service
/setup/v1/locations/:id/services<p>Use this endpoint to <b>Link Services</b> to a location object. A valid business <b>location id</b> is required. By default, there are <i>no services… - DELETEDelete Linked Services
/setup/v1/locations/:id/services<p>Use this endpoint to <b>Delete All</b> location linked services from a business location. A valid business <b>location id</b> is required. </p> - PUTUpdate Location Scope
/setup/v1/locations/:id/settings/scope/:settingsScope<p>Use this endpoint to <b>Update</b> a business locations online booking settings scope. A valid business <b>location id</b> is required.</p> <p>… - POSTUpload Location Image
/setup/v1/locations/:id/uploadimage<p>Use this endpoint to <b>Upload</b> an image to a location object. A valid business <b>location id</b> is required. You must convert the image to a…
ResourceGroups
- GETList Resource Groups
/setup/v1/resourcegroups?locationId=string&deleted=true&offset=0&limit=0<p>Use this endpoint to <b>List Resource Groups</b> for the specified location. If not specified, the business location defaults to the primary business… - POSTCreate Resource Group
/setup/v1/resourcegroups<p>Use this endpoint to <b>Create</b> a resourceGroup object. Resource groups are used to categorize your resources.</p> - GETGet Resource Group
/setup/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… - PUTUpdate Resource Group
/setup/v1/resourcegroups/:id<p>Use this endpoint to <b>Update</b> a resourceGroup object. A valid <b>resourceGroup id</b> is required. </p> - DELETEDelete Resource Group
/setup/v1/resourcegroups/:id<p>Use this endpoint to <b>Delete</b> a resourceGroup object. A valid <b>resourceGroup id</b> is required. The resource group is not permanently deleted and… - PUTRecover Resource Group
/setup/v1/resourcegroups/:id/recover<p>Use this endpoint to <b>Recover</b> a deleted resourceGroup object. A valid <b>resourceGroup id</b> is required.</p>
Resources
- GETList Resources
/setup/v1/resources?locationId=string&resourceGroupId=string&email=string&name=string&deleted=true&googleAuthReturnUrl=string&outlookAuthReturnUrl=string&offset=0&limit=0<p>Use this endpoint to return a <b>List of Resources</b>. The results are returned in pages. Use the offset and limit parameters to control the page start… - POSTCreate Resource
/setup/v1/resources?googleAuthReturnUrl=string&outlookAuthReturnUrl=string<p>Use this endpoint to <b>Create</b> a new resource.</p> <p>Required Fields: <b>Email Address</b> and <b>Name</b></p> <p>Providing a single or many… - GETGet Allocation
/setup/v1/resources/allocations/:id<p>Use this endpoint to return a <b>Resource Allocation</b>. A valid <b>resourceAllocation id</b> is required. </p> - PUTUpdate Allocation
/setup/v1/resources/allocations/:id<p>Use this endpoint to <b>Update</b> a resource allocation. A valid <b>resourceAllocation id</b> is required. Refer to the <i>POST… - DELETEDelete Allocation
/setup/v1/resources/allocations/:id<p>Use this endpoint to <b>Delete</b> a Resource Allocation. A valid <b>resourceAllocation id</b> is required.</p> - PUTUpdate Block
/setup/v1/resources/block/:id<p>Use this endpoint to <b>Update</b> a Resource Block. A valid <b>resourceBlock id</b> is required. Refer to the <i>POST… - DELETEDelete Block
/setup/v1/resources/block/:id<p>Use this endpoint to <b>Delete</b> a Resource Block. A valid <b>resourceBlock id</b> is required.</p> - GETGet Block
/setup/v1/resources/blocks/:id<p>Use this endpoint to <b>Get</b> a Resource Block. A valid <b>resourceBlock id</b> is required.</p> - PUTUpdate Resources Bulk
/setup/v1/resources/bulk?googleAuthReturnUrl=string&outlookAuthReturnUrl=string<p>Use this endpoint to <b>Bulk Update</b> resources. Valid <b>resource id's</b> are required. The list of resources cannot exceed 100 resource objects per… - POSTCreate Resources Bulk
/setup/v1/resources/bulk?googleAuthReturnUrl=string&outlookAuthReturnUrl=string<p>Use this endpoint to <b>Bulk Create</b> resources. Valid <b>resource ids</b> are required. The posted list of resources cannot exceed 100 resource objects… - GETGet Time Zones
/setup/v1/resources/timezones<p>Use this endpoint to return a <b>List of Time Zones</b>.</p> - GETGet Resource
/setup/v1/resources/:id?googleAuthReturnUrl=string&outlookAuthReturnUrl=string<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… - PUTUpdate Resource
/setup/v1/resources/:id?googleAuthReturnUrl=string&outlookAuthReturnUrl=string<p>Use this endpoint to <b>Update</b> a resource. A valid <b>resource id</b> is required.</p> <p>Required Fields: <b>Email Address</b> and <b>Name</b></p>… - DELETEDelete Resource
/setup/v1/resources/:id<p>Use this endpoint to <b>Delete</b> a resource. The resource is not permanently deleted and can be recovered. A valid <b>resource id</b> is required.</p> - GETList Resource Allocations
/setup/v1/resources/:id/allocations?startDate=2024-01-01T00:00:00Z&endDate=2024-01-01T00:00:00Z&offset=0&limit=0<p>Use this endpoint to return a list of <b>Resource Allocations</b> for a specified resource. We recommend using allocations if a resource's schedule changes… - POSTCreate Allocation
/setup/v1/resources/:id/allocations<p>Use this endpoint to <b>Create</b> a resource allocation for a resource. A valid <b>resource id</b> is required.</p> <p>Required fields: <b>startDate,… - GETList Weekly Availability
/setup/v1/resources/:id/availability<p>Use this endpoint to view the <b>Weekly Availability</b> for a resource. The displayed available times are represented in the resource's timezone. The… - PUTUpdate Weekly Availability
/setup/v1/resources/:id/availability<p>Use this endpoint to <b>Update</b> resource weekly availability. A valid <b>resource id</b> is required. The availability day entries are created when a… - POSTCreate Block
/setup/v1/resources/:id/block<p>Use this endpoint to <b>Create</b> a Resource Block. A valid <b>resource id</b> is required.</p> <p>Required fields: <b>startDate, endDate, startTime,… - GETList Resource Blocks
/setup/v1/resources/:id/blocks?startDate=2024-01-01T00:00:00Z&endDate=2024-01-01T00:00:00Z&offset=0&limit=0<p>Use this endpoint to return a list of <b>Resource Blocks</b>. A valid <b>resource id</b> is required. The results are returned in pages. Use the offset and… - GETGet Resource Google URL
/setup/v1/resources/:id/calendar/auth/google/:googleEmailAddress?googleAuthReturnUrl=string<p>Use this endpoint to return the <b>Resources Google Calendar Authorization URL</b>. A valid <b>resource id</b> and <b>Google Email Address</b> are… - GETGet Resource Outlook URL
/setup/v1/resources/:id/calendar/auth/outlook/:outlookEmailAddress?outlookAuthReturnUrl=string<p>Use this endpoint to return the <b>Resources Outlook Calendar Authorization URL</b>. A valid <b>resource id</b> and <b>Outlook Email Address</b> are… - DELETEDelete Resource Image
/setup/v1/resources/:id/deleteimage<p>Use this endpoint to permanently <b>Delete</b> a previously uploaded resource image. A valid <b>resource id</b> is required.</p> - PUTReassign Resource
/setup/v1/resources/:id/reassign/appointments/:resourceId?startDate=2024-01-01T00:00:00Z&endDate=2024-01-01T00:00:00Z&calendarId=string<p>Use this endpoint to <b>Reassign</b> appointments from one resource to another. If the startDate is not supplied, the default is today's date + 1 day; If… - PUTRecover Resource
/setup/v1/resources/:id/recover?googleAuthReturnUrl=string&outlookAuthReturnUrl=string<p>Use this endpoint to <b>Recover</b> a deleted resource. A valid <b>resource id</b> is required.</p> - PUTUpdate Linked Services
/setup/v1/resources/:id/services<p>Use this endpoint to <b>Update</b> the linked services of a Resource. A valid <b>resource id</b> is required.</p> <p>Updating services with this endpoint… - POSTCreate Linked Services
/setup/v1/resources/:id/services<p>Use this endpoint to explicitly <b>Link Services</b> to a Resource. A valid <b>resource id</b> is required.</p> <p> <b>Note:</b> By default, the services… - DELETEDelete Linked Services
/setup/v1/resources/:id/services<p>Use this endpoint to <b>Delete</b> linked services from a Resource, i.e. unlink the services. A valid <b>resource id</b> is required. Once deleted, all… - POSTUpload Resource Image
/setup/v1/resources/:id/uploadimage<p>Use this endpoint to <b>Upload</b> a resource image to the resource. A valid <b>resource id</b> is required. You must convert the image to a <b>base64…
ServiceGroups
- GETList Service Groups
/setup/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 no business location is specified it will default to the Primary… - POSTCreate Service Group
/setup/v1/servicegroups<p>Use this endpoint to <b>Create</b> a Service Group. If no locationId is specified in the body, the business location will default to the primary business… - GETGet Service Group
/setup/v1/servicegroups/:id<p>Use this endpoint to return a <b>Service Group</b> object. A valid <b>serviceGroup id</b> is required. Find service group id's by using the <i>GET… - PUTUpdate Service Group
/setup/v1/servicegroups/:id<p>Use this endpoint to <b>Update</b> a Service Group object. A valid <b>serviceGroup id</b> is required. </p> - DELETEDelete Service Group
/setup/v1/servicegroups/:id<p>Use this endpoint to <b>Delete</b> a Service Group object. A valid <b>serviceGroup id</b> is required. The service group is not permanently deleted and can… - PUTRecover Service Group
/setup/v1/servicegroups/:id/recover<p>Use this endpoint to <b>Recover</b> a deleted Service Group. A valid <b>serviceGroup id</b> is required. </p>
Services
- GETList Services
/setup/v1/services?locationId=string&serviceGroupId=0&deleted=true&offset=0&limit=0<p>Use this endpoint to return a <b>List of Service</b>. The results are returned in pages. Use the offset and limit parameters to control the page start and… - POSTCreate Service
/setup/v1/services<p>Use this endpoint to <b>Create</b> a new service. If not specified, the business location defaults to the primary business location. Note: Posting a… - GETGet Allocation
/setup/v1/services/allocations/:id<p>Use this endpoint to <b>Get a Service Allocation</b>. A valid <b>serviceAllocation id</b> is required.</p> - PUTUpdate Allocation
/setup/v1/services/allocations/:id<p>Use this endpoint to <b>Update</b> a service allocation. A valid <b>serviceAllocation id</b> is required. Refer to the <i>POST… - DELETEDelete Allocation
/setup/v1/services/allocations/:id<p>Use this endpoint to permanently <b>Delete</b> a service allocation. A valid <b>serviceAllocation id</b> is required.</p> - PUTUpdate Block
/setup/v1/services/block/:id<p>Use this endpoint to <b>Update</b> a Service Block. A valid <b>serviceBlock id</b> is required.</p> - DELETEDelete Block
/setup/v1/services/block/:id<p>Use this endpoint to permanently <b>Delete</b> a Service Block. A valid <b>serviceBlock id</b> is required.</p> - GETGet Block
/setup/v1/services/blocks/:id<p>Use this endpoint to <b>Get a Service Block</b>. A valid <b>serviceBlock id</b> is required.</p> - POSTLink Service to Calendar
/setup/v1/services/calendar<p>Use this endpoint to <b>Link a Service</b> to a calendar. </p> - DELETEDelete Service Links
/setup/v1/services/calendar/:id<p>Use this endpoint to <b>Delete</b> service links from the calendar specified. A valid <b>calendar id</b> is required.</p> - GETGet Service
/setup/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 /setup/v1/services</i>… - PUTUpdate Service
/setup/v1/services/:id<p>Use this endpoint to <b>Update</b> a service object. A valid <b>service id</b> is required.</p> - DELETEDelete Service
/setup/v1/services/:id<p>Use this endpoint to <b>Delete</b> a service object. A valid <b>service id</b> is required. The service is not permanently deleted and can be recovered by… - GETList Service Allocations
/setup/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> for a specified service. A valid <b>service id</b> is required. Service allocations are… - POSTCreate Allocation
/setup/v1/services/:id/allocations<p>Use this endpoint to <b>Create</b> a service allocation for a service. A valid <b>service id</b> is required. Service allocations are used for <b>Event… - POSTCreate Allocations Bulk
/setup/v1/services/:id/allocations/bulk<p>Use this endpoint to <b>Create</b> bulk service allocations. A valid <b>service id</b> is required. Use this endpoint only if you need to POST multiple… - GETGet Weekly Availability
/setup/v1/services/:id/availability<p>Use this endpoint to return the <b>Weekly Service Availability</b> for an appointment service. A valid <b>service id</b> is required. Weekly availability… - PUTUpdate Weekly Availability
/setup/v1/services/:id/availability<p>Use this endpoint to <b>Update</b> service weekly availability. A valid <b>service id</b> is required. The availability day entries are created when a… - POSTCreate Block
/setup/v1/services/:id/block<p>Use this endpoint to <b>Create</b> a Service Block. A valid <b>service id</b> is required.</p> <p>Required fields: <b>startDate, endDate, startTime,… - GETList Service Blocks
/setup/v1/services/:id/blocks?startDate=2024-01-01T00:00:00Z&endDate=2024-01-01T00:00:00Z&offset=0&limit=0<p>Use this endpoint to return a list of <b>Service Blocks</b>. The results are returned in pages. Use the offset and limit parameters to control the page… - GETGet Linked Calendar
/setup/v1/services/:id/calendar?locationId=string<p>Use this endpoint to <b>Get the Linked Calendar</b> for the service requested. A valid <b>service id</b> is required. A service can only be linked to one… - DELETEDelete Service Image
/setup/v1/services/:id/deleteimage<p>Use this endpoint to permanently <b>Delete</b> a previously uploaded service image. A valid <b>service id</b> is required.</p> - PUTRecover Service
/setup/v1/services/:id/recover<p>Use this endpoint to <b>Recover</b> a deleted service object. A valid <b>service id</b> is required.</p> - GETList Resources for Service
/setup/v1/services/:id/resources?offset=0&limit=0&googleAuthReturnUrl=string&outlookAuthReturnUrl=string<p>Use this endpoint to return a list of <b>Resources</b> that provide the requested service. A valid <b>service id</b> is required. Use the offset and limit… - POSTUpload Service Image
/setup/v1/services/:id/uploadimage<p>Use this endpoint to <b>Upload</b> an image to the service. A valid <b>service id</b> is required. You must convert the image to a <b>base64 encoded…
API details
- Base URL
https://sandbox-api.onsched.com- Authentication
- OAuth 2.0 (client credentials flow) with 2 scopes
- Operations
- 138 operations on 84 pathsGET 54PUT 30POST 28DELETE 26
- Main resources
- Resources 29Locations 28Services 25Companies 19Calendars 12BusinessUsers 7ResourceGroups 6ServiceGroups 6Appointments 3Customers 3
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
v1 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the OnSched Setup API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the OnSched Setup API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “List Appointments” (GET /setup/v1/appointments?locationId=string&email=string&lastname=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 Setup API?
Build secure and scalable custom apps for onboarding and setup. Our flexible API provides many options for configuration. Take the API for a test drive. Just… It is listed under Developer tools and has 138 endpoints.
Who publishes the OnSched Setup 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 Setup API?
Requests go to https://sandbox-api.onsched.com. Endpoint paths are added to this base URL.
How do I authenticate with the OnSched Setup API?
With OAuth 2.0 (client credentials flow) with 2 scopes.
How many endpoints does the OnSched Setup API have?
138 operations on 84 paths (54 GET, 30 PUT, 28 POST, 26 DELETE). The largest groups are Resources, Locations, Services, Companies.
Is forking the OnSched Setup API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.