v1

latestOpenAPI 3.0.12026-07-133870165.8 KB
Locations

Get Location

Use this endpoint to return a Location object. A valid business location id is required. Find all 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: support@onsched.com as we do not want to interrupt your existing workflows.

get/consumer/v1/locations/{id}

Path parameters

idstring required

id of business location

Response

Success

objectstring nullable
idstring nullable
friendlyIdstring nullable
companyIdstring nullable
companyNamestring nullable
namestring nullable
adminEmailstring nullable
adminNamestring nullable
phonestring nullable
faxstring nullable
emailstring nullable
websitestring nullable
regionIdstring nullable
logostring nullable
imageUrlstring nullable
timezoneIdstring nullable
timezoneIanastring nullable
timezoneOffsetinteger nullable
primaryBusinessboolean
primaryCalendarIdstring nullable
latitudenumber double
longitudenumber double