These docs are for v1.0. Click to read the latest docs for v3-prod.

List 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: [email protected] as we do not want to interrupt your existing workflows.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Location name (full or partial)

string

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

int32

Maximum distance to display

string

Distance either imperial(miles), metric(kilometers)

string

Locations that offer this service

string

Frienldy Id of location

string

Locations within a specific region

boolean

Don't include the Primary Location

int32

Starting row of page, default 0

int32

Page limit, default 20, max 100

Response

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json