OnSched Setup API

Get Location Use this endpoint to return a Location object. A valid location id is required. If not specified, the business location defaults to the primary business location. Find all business location id's, by using the GET /consumer/v1/locations endpoint. IMPORTANT DEPRECATION NOTICE: The following online settings parameters were intended for internal use in our Portal application only. They will be deprecated on OCTOBER 15, 2022. These fields are currently part of the SETTINGS object in all location endpoints: businessId, enabled, familyMembersEnabled, serviceLabel, resourceLabel, resourceAnyLabel, resourceSelection, liveMode, formFlow, availabilityForm, showServiceGroups, showOnSchedLogo, showBusinessLogo, disableAuthorization, hideNavBar, hideLocationNav, hideServiceGroupsNav, hideServicesNav, hideContinueBooking, returnToService, returnToAvailability, hideBreadCrumbNav. If you are using these fields, please adjust your code to handle the deprecation or let us know by submitting a ticket to: [email protected] as we do not want to interrupt your existing workflows.

Get Reminders Use this endpoint to Get Email and SMS appointment reminder settings for the requested location. A valid business location id is required.

List Email Templates Use this endpoint to return a List of Email Templates that are provided and may be customized. If the template has been customized, the customized property is true. The scope parameter indicates if the email template has been customized. This endpoint returns only company level templates, so the scope is always company.

Get Master Template Settings Use this endpoint to get Master Email Template Settings. A valid business location id is required. Settings exist for showing or hiding panels and for changing color schemes.

Get Email Template Use this endpoint to return the requested Email Template. The template is from the primary business location. If it wasn't customized the default template is returned. The response content is in html format. A valid emailTemplate name is required. Find template names by using the GET ​/setup​/v1​/locations​/{id}​/email​/templates endpoint. Note: The master template cannot be accessed here.

Google Service Account Info Use this endpoint to get Google Service Account info and optionally, verify each Resource within the Google API using the Service Account. A valid business location id is required.

List Location Linked Services Use this endpoint to return a list of Location Linked Services. A valid business location id is required. By default, there are no location linked services attached to a location. Refer to the: POST /setup​/v1​/locations​/{id}​/services for details. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

Get Linked Service Use this endpoint to Get a Linked Service. A valid locationService id is required.

List Resource Groups Use this endpoint to List Resource Groups for the specified location. If not specified, the business location defaults to the primary business location. Name is a required field. Use the offset and limit parameters to control the page start and size. Default offset is 0, limit is 20, maximum is 100. Use the query parameters to filter the results further.

Get Resource Group Use this endpoint to return a Resource Group object. A valid resourceGroup id is required. Find resourceGroup id's by using the GET setup/v1/resourceGroups endpoint.

List Resources Use this endpoint to return a List of Resources. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

Get Allocation Use this endpoint to return a Resource Allocation. A valid resourceAllocation id is required.

Get Block Use this endpoint to Get a Resource Block. A valid resourceBlock id is required.

Get Resource Use this endpoint to return a Resource object. A valid resource id is required. Find resource id's by using the: GET /setup/v1/resources endpoint.

List Resource Allocations Use this endpoint to return a list of Resource Allocations for a specified resource. We recommend using allocations if a resource's schedule changes frequently from day to day or week to week. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

List Weekly Availability Use this endpoint to view the Weekly Availability for a resource. The displayed available times are represented in the resource's timezone. The resource timezone can be set to any world timezone. If not provided, by default it is set to the Business timezone.

List Resource Blocks Use this endpoint to return a list of Resource Blocks. A valid resource id is required. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

Get Resource Google URL Use this endpoint to return the Resources Google Calendar Authorization URL. A valid resource id and Google Email Address are required.

Get Resource Outlook URL Use this endpoint to return the Resources Outlook Calendar Authorization URL. A valid resource id and Outlook Email Address are required.

Get Time Zones Use this endpoint to return a List of Time Zones.

List Service Groups Use this endpoint to return a list of Service Groups for the requested location. If no business location is specified it will default to the Primary Business Location of the company. Use the offset and limit parameters to control the page start and size. Default offset is 0, limit is 20, maximum is 100. Use the other query parameters to filter the results further.

Get Service Group Use this endpoint to return a Service Group object. A valid serviceGroup id is required. Find service group id's by using the GET /setup/v1/serviceGroups endpoint.

List Services Use this endpoint to return a List of Service. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

Get Allocation Use this endpoint to Get a Service Allocation. A valid serviceAllocation id is required.

Get Block Use this endpoint to Get a Service Block. A valid serviceBlock id is required.

Get Service Use this endpoint to return a Service object. A valid service id is required. Find service id's by using the GET /setup/v1/services endpoint.

List Service Allocations Use this endpoint to return a List of Service Allocations for a specified service. A valid service id is required. Service allocations are used for Event type services only where the events are offered on specific dates and times. Retrieve all allocations for a location by passing in 0 as the service id. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

Get Weekly Availability Use this endpoint to return the Weekly Service Availability for an appointment service. A valid service id is required. Weekly availability is returned for services where the Type = 1. For event type services, where service Type = 2, refer to the GET ​/setup​/v1​/services​/{id}​/allocations endpoint.

List Service Blocks Use this endpoint to return a list of Service Blocks. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

Get Linked Calendar Use this endpoint to Get the Linked Calendar for the service requested. A valid service id is required. A service can only be linked to one calendar in a location.

List Resources for Service Use this endpoint to return a list of Resources that provide the requested service. A valid service id is required. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

Create User Use this endpoint to Create a Business User. If not specified, the business location defaults to the primary business location. Required fields: Name, Email and RoleNote: If the businessUser is a bookable resource (bizresource) then a resourceId is required. For role, use one of the values listed. Business Roles Include: bizowner (Business Owner), bizadmin (Business Administrator), bizresource (Business User - Bookable Resource). The sendRegistrationInvite parameter is available to API consumers for their own use. It provides no added functionality in OnSched.

DEPRECATING: Create Calendar We are no longer supporting Multiple Calendar Functionality as it is part of our Legacy Application and has no relevance in the API.

Create Calendar Block Use this endpoint to Create a Calendar Block. A valid calendar id is required. Required fields: startDate, endDate, startTime, endTime and reason. Calendar blocks can be set to specific time ranges or for the whole day. Th block a whole day set the startTime to 0 and endTime to 2400. Calendar blocks can be for a specific date range instance or set to repeat at a specified frequency. Repeat object: (repeats = true) The frequency can be set to a value of D, W or M for Day, Week or Month respectively. Use the interval property to specify the interval that the block repeats. For example, an interval of 2 for a weekly block means that the block will repeat every 2nd week beginning at the day specified. A daily block with an interval of 10 means the block will repeat every 10 days. The interval property applies to all repeat frequencies. If using the repeat functionality an interval value is required. DAILY BLOCKS: Will repeat for each day of the week for the date range specified for the interval specified. An interval value of “1” repeats every day, and an interval value of “3” is every 3rd day. WEEKLY BLOCKS: Will repeat only on the specified days of the week for the date range specified. For weekly the frequency is required and should be set to “W”. You must specify the weekdays parameter. Weekdays are expressed as a string of digits with each single digit in the string representing a day of the week. The possible values are 0,1,2,3,4,5,6 where 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday. For example, a weekly frequency with an interval of “1”, and an entry of weekdays = “24”, will repeat each week on Tuesday and Thursday for the duration of the block date range. MONTHLY BLOCKS: Will repeat either on the day of the month specified in the monthDay property or on the day of the week and week of the month specified by the monthType property. In both cases frequency is required and should be set to “M”, monthly, monthDay is the day of the month you want blocked. If monthDay=’15’ this means to block the 15th of every month in the date range requested. Using monthDay in conjunction with monthType addresses “day of the week and week of the month” scenario. There are two possible values for monthType: D for Day of Month or W for Week of Month. For monthType D, monthDay value must be between 1 and 31. It is the day of the month to repeat on. For monthType M, monthDay value contains 2 digits: day of week (0-6), (0,1,2,3,4,5,6 where 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday) and week of month (1-5). 1 being the first week, 2 being the second. The third Thursday of the month is depicted as a monthType=”M” and monthDay=”43”. Repeats will end on the date specified by the end date.

Create Company Use this endpoint to Create a new authorized company. Note: Special API Partner credentials are required to access this endpoint. The name, registrationEmail, phone, country and timezoneName are required fields. For country use the standard ISO 3166 2-character country code. The timezoneName must be expressed as an IANA Timezone e.g., America/New_York. For more information: Timezone IANA Wiki

Create Company Domain Use this endpoint to Create an OnSchedJs domain for your authorized company. To share the OnSchedJS booking widget on your website or in your application you must add the domain.

Create Master Template Settings Use this endpoint to Create Custom Master Email Template Settings. Settings exist for showing or hiding email panels and for changing color schemes. Use the GET ​/setup​/v1​/companies​/email​/templates endpoint to display the settings offered. Changes to the Master Template Settings will be reflected in all business locations associated with this company. The email template endpoints work a little differently than most. There are no endpoints to update the templates, we use the post endpoint to create a custom template instead. This endpoint creates a new custom Master Template Settings file that will be used instead. If you delete it you are deleting the custom template settings you created and the original default Master Template created by OnSched would be reactivated.

Create Region Use this endpoint to Create a region object. Regions can be mapped to business locations. They can be used by the locations endpoints to filter locations by region id.

Create Location Use this endpoint to Create a new business location. The result is a business location object with a GUID assigned to the location. The name and timezoneName fields are required. The timezoneName must be expressed as an IANA Timezone e.g., America/New_York. Refer to: Timezone Wiki for a listing of IANA time zones. Business hours are set by defining the startTime and endTime values for each day available/open. All days of the week must be provided when setting availability. Days are defined as sun, mon, tue, wed, thu, fri and sat. Start and End Times are entered in military format. e.g., 800 is 8:00am, 2230 is 10:30pm. If there is no physical location and the business hours are irrelevant, set the hours to open 24 hours by setting startTime=0 and endTime=2400. To set a whole day as unavailable, set both the startTime and endTime to 0. Settings can be set here. Booking timer minutes, book ahead restrictions and customer bookings per day are all available here. Please read about the settings scope parameter before setting these values as it may simplify your process. Settings Scope can be set to the company or the business location level. You can have all locations use the same company level settings or individual business locations can define their own, business location scope. If you want to use the company settings throughout all locations, do not pass in settings element. To create business location scoped settings, pass in the settings element with the field values defined in the post body. Appointment Reminders Reminder values are used to define how many hours, days, or weeks (interval value) prior to the appointment to send the reminder. Interval values are used to define the reminder interval: 1 = Hours, 2 = Days and 3 = Weeks. The reminder fields are numbers. If you are using the hours interval, use a number from 1 to 24. Example 1: emailFirstReminder: 1, emailFirstReminderInterval: 2 - results in 1st reminder being sent 1 Day before the appointment time. Example 2: emailSecondReminder: 3, emailSecondReminderInterval: 1 - results in 2nd reminder being sent 3 Hours before the appointment time. IMPORTANT DEPRECATION NOTICE: The following online settings parameters were intended for internal use in our Portal application only. They will be deprecated on OCTOBER 15, 2022. These fields are currently part of the SETTINGS object in all location endpoints: businessId, enabled, familyMembersEnabled, serviceLabel, resourceLabel, resourceAnyLabel, resourceSelection, liveMode, formFlow, availabilityForm, showServiceGroups, showOnSchedLogo, showBusinessLogo, disableAuthorization, hideNavBar, hideLocationNav, hideServiceGroupsNav, hideServicesNav, hideContinueBooking, returnToService, returnToAvailability, hideBreadCrumbNav. If you are using these fields, please adjust your code to handle the deprecation or let us know by submitting a ticket to: [email protected] as we do not want to interrupt your existing workflows.

Create Locations Bulk Use this endpoint to Create Bulk business locations. The posted list of locations cannot exceed 100 location objects per transaction for performance purposes. The result is a list of new business location objects with a GUID assigned to each location. The name and timezoneName fields are required. The timezoneName must be expressed as an IANA Timezone e.g., America/New_York. Refer to: Timezone Wiki for a listing of IANA time zones. Business hours are set by defining the startTime and endTime values for each day available/open. All days of the week must be provided when setting availability. Days are defined as sun, mon, tue, wed, thu, fri and sat. Start and End Times are entered in military format. e.g., 800 is 8:00am, 2230 is 10:30pm. If there is no physical location and the business hours are irrelevant, set the hours to open 24 hours by setting startTime=0 and endTime=2400. To set a whole day as unavailable, set both the startTime and endTime to 0. Settings can be set here. Booking timer minutes, book ahead restrictions and customer bookings per day are all available here. Please read about the settings scope parameter before setting these values as it may simplify your process. Settings Scope can be set to the company or the business location level. You can have all locations use the same company level settings or individual business locations can define their own, business location scope. If you want to use the company settings throughout all locations, do not pass in settings element. To create business location scoped settings, pass in the settings element with the field values defined in the post body. Appointment Reminders Reminder values are used to define how many hours, days, or weeks (interval value) prior to the appointment to send the reminder. Interval values are used to define the reminder interval: 1 = Hours, 2 = Days and 3 = Weeks. The reminder fields are numbers. If you are using the hours interval, use a number from 1 to 24. Example 1: emailFirstReminder: 1, emailFirstReminderInterval: 2 - results in 1st reminder being sent 1 Day before the appointment time. Example 2: emailSecondReminder: 3, emailSecondReminderInterval: 1 - results in 2nd reminder being sent 3 Hours before the appointment time. IMPORTANT DEPRECATION NOTICE: The following online settings parameters were intended for internal use in our Portal application only. They will be deprecated on OCTOBER 15, 2022. These fields are currently part of the SETTINGS object in all location endpoints: businessId, enabled, familyMembersEnabled, serviceLabel, resourceLabel, resourceAnyLabel, resourceSelection, liveMode, formFlow, availabilityForm, showServiceGroups, showOnSchedLogo, showBusinessLogo, disableAuthorization, hideNavBar, hideLocationNav, hideServiceGroupsNav, hideServicesNav, hideContinueBooking, returnToService, returnToAvailability, hideBreadCrumbNav. If you are using these fields, please adjust your code to handle the deprecation or let us know by submitting a ticket to: [email protected] as we do not want to interrupt your existing workflows.

Create Custom Template Use this endpoint to a Create a Custom Email Template. You must convert the content to a base64 encoded string. Updates to the primary business location create company scoped custom templates. Updates to non-primary business locations create business location scoped custom templates. The master template cannot be updated with this endpoint. The email template endpoints work a little differently than most. There are no endpoints to update the templates, we use the post endpoint to create a custom template instead. This endpoint creates a new email template that will be used instead. If you delete it, you are deleting the custom template you created and the original default template created by OnSched will be reactivated.

Create Master Template Settings Use this endpoint to Create Custom Master Email Template Settings. A valid business location id is required. Settings exist for showing or hiding email panels and for changing color schemes. Use the GET ​/setup​/v1​/locations​/{id}​/email​/templates​/masterSettings endpoint to display the settings offered. Changes to the Master Template Settings will be reflected in all business locations associated with this company. The email template endpoints work a little differently than most. There are no endpoints to update the templates, we use the post endpoint to create a custom template instead. This endpoint creates a new custom Master Template Settings file that will be used instead. If you delete it, you are deleting the custom template settings you created and the original default Master Template created by OnSched would be reactivated.

Create Google Cal Access Use this endpoint to Authorize Access to google calendar users in your organization. You must create/have a Google Service account as an admin of your GSuite, then save the credentials as a Json Key file. This Json Key and a valid business location id are required.

Create Linked Service Use this endpoint to Link Services to a location object. A valid business location id is required. By default, there are no services linked to a location. Services are definable globally at the Company level and associated with the Primary Business Location, or at a Secondary Business Location. When accessing the Services endpoints, by default, API consumers are provided with a combined list of Services defined from both the Primary and Secondary Business Location. If necessary, the list of Service(s) provided can be cherry-picked/linked to only include specific Service(s) by using this endpoint. This allows for a subset of defined Services to be provided for a location. Supplying the list of services ids to cherry-pick/link to the location in the request body will explicitly define which Primary Location Services are offered by the specified business location.

Upload Location Image Use this endpoint to Upload an image to a location object. A valid business location id is required. You must convert the image to a base64 encoded string and pass that string as input along with your filename.

Create Resource Group Use this endpoint to Create a resourceGroup object. Resource groups are used to categorize your resources.

Create Resource Use this endpoint to Create a new resource. Required Fields: Email Address and Name Providing a single or many serviceId(s) in the service array will result the resource explicitly being available to provide those services only. While passing in an empty array will result in all services being available to the resources. This includes all company and business scoped services. See the POST ​/setup​/v1​/resources​/{id}​/services endpoint for details about explicitly linking services. Set the resource availability type by using the recurringAvailability flag. Set recurringAvailability to True for Weekly Availability or False for Resource Allocations.

Create Resources Bulk Use this endpoint to Bulk Create resources. Valid resource ids are required. The posted list of resources cannot exceed 100 resource objects per transaction for performance purposes. Required Fields: Email Address and Name Providing a single or many serviceId(s) in the service array will result the resource explicitly being available to provide those services only. While passing in an empty array will result in all services being available to the resources. This includes all company and business scoped services. See the POST ​/setup​/v1​/resources​/{id}​/services endpoint for details about explicitly linking services. Set the resource availability type by using the recurringAvailability flag. Set recurringAvailability to True for Weekly Availability or False for Resource Allocations.

Create Allocation Use this endpoint to Create a resource allocation for a resource. A valid resource id is required. Required fields: startDate, endDate, startTime, endTime and reason. Resource allocations can be set to specific time ranges or for the whole day by setting startTime=0 and endTime=2400. They can repeat for a specific date range instance or set to repeat at a specified frequency. Repeat object: (repeats = true) The frequency can be set to a value of D, W or M for Day, Week or Month respectively. Use the interval property to specify the interval that the allocation repeats. For example, an interval of 2 for a weekly allocation means that the allocation will repeat every 2nd week beginning at the day specified. A daily allocation with an interval of 10 means the allocation will repeat every 10 days. The interval property applies to all repeat frequencies. If using the repeat functionality an interval value is required. DAILY ALLOCATIONS: Will repeat for each day of the week for the date range specified for the interval specified. An interval value of “1” repeats every day, and an interval value of “3” is every 3rd day. WEEKLY ALLOCATIONS: Will repeat only on the specified days of the week for the date range specified. For weekly the frequency is required and should be set to “W”. You must specify the “weekdays” parameter. Weekdays are expressed as a string of digits with each single digit in the string representing a day of the week. The possible values are 0,1,2,3,4,5,6 where 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday. For example, a weekly frequency with an interval of “1”, and an entry of weekdays = “24”, will repeat each week on Tuesday and Thursday for the duration of the allocation date range. MONTHLY ALLOCATIONS: Will repeat either on the day of the month specified in the monthDay property or on the day of the week and week of the month specified by the monthType property. In both cases frequency is required and should be set to “M”, monthly. monthDay is the day of the month you want allocated. If monthDay=’15’ this means to allocate the 15th of every month in the date range requested. Using monthDay in conjunction with monthType addresses “day of the week and week of the month” scenario. There are two possible values for monthType: D for Day of Month or W for Week of Month. For monthType D, monthDay value must be between 1 and 31. It is the day of the month to repeat on. For monthType M, monthDay value contains 2 digits: day of week (0-6), (0,1,2,3,4,5,6 where 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday) and week of month (1-5). 1 being the first week, 2 being the second. The third Thursday of the month is depicted as a monthType=”M” and monthDay=”43”. Repeats will end on the date specified by the end date.

Create Block Use this endpoint to Create a Resource Block. A valid resource id is required. Required fields: startDate, endDate, startTime, endTime and reason. Resource blocks can be set to specific time ranges or for the whole day. Use the AllDay setting to create an all-day block. AllDay will automatically set startTime to 0 and endTime to 2400. Resource blocks can be for a specific date range instance or set to repeat at a specified frequency. Repeat object: (repeats = true) The frequency can be set to a value of D, W or M for Day, Week or Month respectively. Use the interval property to specify the interval that the block repeats. For example, an interval of 2 for a weekly block means that the block will repeat every 2nd week beginning at the day specified. A daily block with an interval of 10 means the block will repeat every 10 days. The interval property applies to all repeat frequencies. If using the repeat functionality an interval value is required. DAILY BLOCKS: Will repeat for each day of the week for the date range specified for the interval specified. An interval value of “1” repeats every day, and an interval value of “3” is every 3rd day. WEEKLY BLOCKS: Will repeat only on the specified days of the week for the date range specified. For weekly the frequency is required and should be set to “W”. You must specify the weekdays parameter. Weekdays are expressed as a string of digits with each single digit in the string representing a day of the week. The possible values are 0,1,2,3,4,5,6 where 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday. For example, a weekly frequency with an interval of “1”, and an entry of weekdays = “24”, will repeat each week on Tuesday and Thursday for the duration of the block date range. MONTHLY BLOCKS: Will repeat either on the day of the month specified in the monthDay property or on the day of the week and week of the month specified by the monthType property. In both cases frequency is required and should be set to “M”, monthly, monthDay is the day of the month you want blocked. If monthDay=’15’ this means to block the 15th of every month in the date range requested. Using monthDay in conjunction with monthType addresses “day of the week and week of the month” scenario. There are two possible values for monthType: D for Day of Month or W for Week of Month. For monthType D, monthDay value must be between 1 and 31. It is the day of the month to repeat on. For monthType M, monthDay value contains 2 digits: day of week (0-6), (0,1,2,3,4,5,6 where 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday) and week of month (1-5). 1 being the first week, 2 being the second. The third Thursday of the month is depicted as a monthType=”M” and monthDay=”43”. Repeats will end on the date specified by the end date.