LocalLocationList

⌘K

List all active locations.

JSON-RPC Method:

local.location.list
Go to Example Code

Request

page

object

Control how much data is returned by providing a specific page number (n) and limit to the number of results in a given page.


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:

activecanceledclosed

legacy_id

number

The legacy ID of the location.

brand_id

number

The id of the brand to create the location under.

auto_sync_enabled

boolean

(Optional)

Enables or disables automatic data synchronization to native networks

Default Value: false

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

keywords

array

The keyword(s) associated with your business

brands

array

The brand(s) associated with your business

payment_forms

array

List of forms of payment accepted

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

services

string

(Optional)

Location services

primary_category

string

(Optional)

The primary category ID from Google

additional_categories

array

Array of additionally applicable category ids

attributes

array

Array of attributes.

id

string

The id from Google

value

string

The string value

address

object

The location's physical address

lat

number

(Optional)

The location's latitude

long

number

(Optional)

The location's longitude

opening_status

string

(Optional)

The location open status

Default Value: open

Acceptable Values:

openselected_hoursalways_opentemporarily_closedpermanently_closed

reopen_date

string

(Optional)

Reopen date if location is temporarily closed

hours

object

The regular opening hours keyed by the day

more_hours

object

(Optional)

Service-based opening hours keyed by the function

opening_hours_notes

string

(Optional)

Notes pertaining to opening hours

opening_date

string

(Optional)

The date the business opened or is expected to open

special_hours

object

(Optional)

The special opening hours keyed by the date in YYYY-MM-DD format

phone

string

(Optional)

The primary phone numberfor the location

fax

string

(Optional)

The primary fax numberfor the location

1{
2  "locations": [
3    {
4      "id": 4,
5      "level": "local-lite",
6      "status": "active",
7      "legacy_id": 667273870,
8      "brand_id": 1,
9      "auto_sync_enabled": true,
10      "remote_id": "ExampleBusiness",
11      "listings_name": "Example Business",
12      "location_name": "Example Business",
13      "website_url": "https://www.example-business.com",
14      "email_address": "info@example-business.com",
15      "store_code": "",
16      "short_description": "Doing things since 1986.",
17      "long_description": "Really long descriptions.",
18      "languages": [],
19      "keywords": [
20        "tutoring",
21        "online tutoring",
22        "test preparation",
23        "academic tutoring"
24      ],
25      "brands": [
26        "example"
27      ],
28      "payment_forms": [],
29      "price_range": "omit",
30      "service_areas": [],
31      "service_area_only": false,
32      "services": "",
33      "primary_category": "gcid:educational_consultant",
34      "additional_categories": [
35        "gcid:tutoring_service",
36        "gcid:private_tutor"
37      ],
38      "attributes": [],
39      "address": {
40        "address_line_1": "1234 Astroworld Ave",
41        "address_line_2": "Suite 306",
42        "sublocality": "",
43        "county": "Roswell",
44        "city": "Schenectady",
45        "state_province": "NY",
46        "postal_code": "12345",
47        "country": "US"
48      },
49      "opening_status": "open",
50      "reopen_date": "0000-00-00",
51      "hours": {
52        "monday": [
53          "09:00-21:00"
54        ],
55        "tuesday": [
56          "09:00-21:00"
57        ],
58        "wednesday": [
59          "09:00-21:00"
60        ],
61        "thursday": [
62          "09:00-21:00"
63        ],
64        "friday": [
65          "09:00-21:00"
66        ],
67        "saturday": [
68          "09:00-21:00"
69        ],
70        "sunday": [
71          "09:00-21:00"
72        ]
73      },
74      "more_hours": {
75        "kitchen hours": {
76          "monday": [
77            "09:00-21:00"
78          ]
79        }
80      },
81      "opening_hours_notes": "",
82      "opening_date": "0000-00-00",
83      "special_hours": {
84        "2025-08-04": [
85          "04:00-02:30"
86        ],
87        "2025-08-05": [
88          "04:00-02:30"
89        ],
90        "2025-08-06": [
91          "04:00-02:30"
92        ]
93      },
94      "network_fields": [],
95      "phone": "+1 561-395-5555",
96      "fax": ""
97    }
98  ]
99}

Example Code

Quota Usage

Does not require any quota.