v1
latestOpenAPI 3.0.12026-07-133870165.8 KBList Locations
Use this endpoint to return a List of Business Locations. The results are returned in pages. Use the offset and limit parameters to control the page start and size. Default offset is 0, and limit is 20 and maximum is 100. Use the other 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.
Query parameters
Location name (full or partial)
Search by distance nearest Geocoords, City, Postal/Zip Code
Maximum distance to display
Distance either imperial(miles), metric(kilometers)
Locations that offer this service
Frienldy Id of location
Locations within a specific region
Don't include the Primary Location
Starting row of page, default 0
Page limit, default 20, max 100
Response
Success