GET /consumer/v1/locations

onsched.com:consumer

Summary: List Locations
Operation ID:
Auth: unknown
Description

<p>Use this endpoint to return a <b>List of Business Locations</b>. 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. </p> <p> <b>IMPORTANT DEPRECATION NOTICE</b>: The following online settings parameters were intended for internal use in our Portal application only. They will be deprecated on <b>OCTOBER 15, 2022</b>. These fields are currently part of the <b>SETTINGS</b> object in all location endpoints: <b>businessId, enabled, familyMembersEnabled, serviceLabel, resourceLabel, resourceAnyLabel, resourceSelection, liveMode, formFlow, availabilityForm, showServiceGroups, showOnSchedLogo, showBusinessLogo, disableAuthorization, hideNavBar, hideLocationNav, hideServiceGroupsNav, hideServicesNav, hideContinueBooking, returnToService, returnToAvailability, hideBreadCrumbNav.</b> If you are using these fields, please adjust your code to handle the deprecation or let us know by submitting a ticket to: <b><i>support@onsched.com</i></b> as we do not want to interrupt your existing workflows.</p>

Parameters (10)

friendlyId (string, query, optional)

Frienldy Id of location

ignorePrimary (boolean, query, optional)

Don't include the Primary Location

limit (integer, query, optional)

Page limit, default 20, max 100

name (string, query, optional)

Location name (full or partial)

nearestTo (string, query, optional)

Search by distance nearest Geocoords, City, Postal/Zip Code

offset (integer, query, optional)

Starting row of page, default 0

proximity (integer, query, optional)

Maximum distance to display

regionId (string, query, optional)

Locations within a specific region

serviceId (string, query, optional)

Locations that offer this service

units (string, query, optional)

Distance either imperial(miles), metric(kilometers)

No probe data for this endpoint yet.