v1

latestOpenAPI 3.0.12026-07-13139143370.4 KB
Locations

List Locations

Use this endpoint to List Business Locations associated with your company. 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.

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/setup/v1/locations

Query parameters

namestring

Location name(full or partial) to filter on

serviceIdstring

Find locations that offer this service

friendlyIdstring

friendlyId of location

deletedboolean

Filter locations on deleted status

offsetinteger

Starting row of page, default 0

limitinteger

Page limit default 20, max 100

Response

Success

objectstring nullable
urlstring nullable
hasMoreboolean
countinteger
totalinteger