Control the number of results returned per call in addition to fetching additional results. The default limit is 25 with an n value of 0 (indicating the first page of results). Make subsequent calls to the endpoint with incrementing n values to fetch additional pages of results. To get all results, you must continue making calls with incrementing n values until an empty result set is returned.
Response
locations
array
id
number
The id of the location
level
string
The name of the tier of service for the location.
status
string
The status of the location
Acceptable Values:
activecanceledclosedsuspended
account_id
number | null
The id of the local account the location resides in. May be null for legacy inactive locations.
auto_sync_enabled
boolean
(Optional)
Enables or disables automatic data synchronization to native networks
Default Value:false
custom_fields
object
Custom fields for the location.
remote_id
string
(Optional)
The internal ID property of the source of data
listings_name
string
The listings name (that gets published) of the location
location_name
string
(Optional)
The internal name of the location
website_url
string
(Optional)
The website URL for the location
email_address
string
(Optional)
The email address for the location, or a corporate email address
timezone
string
(Optional)
The location timezone
store_code
string
(Optional)
Unique store identifier
tagline
string
(Optional)
Tagline or main headline for the location
short_description
string
(Optional)
A short description up to 255 characters
long_description
string
(Optional)
A long description up to 750 characters
languages
array
The language(s) in which customers can interact with the location's staff
items
string
(Optional)
A language in which customers can interact with the location's staff
Acceptable Values:
en_USen_CAen_GBen_INen_PI
keywords
array
The keyword(s) associated with your business
items
string
(Optional)
A keyword used to describe your business
brands
array
The brand(s) associated with your business
items
string
(Optional)
A brand associated with your business
payment_forms
array
List of forms of payment accepted
items
string
(Optional)
A form of payment accepted
Acceptable Values:
American ExpressDiscoverGoogle PayApple PayCash
price_range
string
(Optional)
The location's product or service estimated price range
Acceptable Values:
omit$$$$$$$$$$
service_areas
array
All applicable page service areas found using Google Places
text
string
The name of the place
id
string
The place id found using Google Places search
service_area_only
boolean
(Optional)
Set this location as a "service-area only" business