HighLevel: Search

← Locations operations · Get started

Operation gohighlevel.search_locations

Provider route: GET /locations/search. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["locations"]["searchLocations"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.locations.searchLocations(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.locations.search_locations(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.companyId	string	Optional
query.skip	string	Optional	Default: 0
query.limit	string	Optional	Default: 10
query.order	string	Optional	Default: asc
query.email	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Search — response body

Referenced models: Search — response body

Schemas

Search — response body

Field	Type	Presence	Description and constraints
$	object	Root
locations	array	Optional
locations[]	Model	Each item	Expand Search — response body — locations item

Referenced models: Search — response body — locations item

Search — response body — locations item

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	The address of the business for which sub-account is created
city	string	Optional	The city where the business is located for which sub-account is created
country	string	Optional	The country in which the business is present for which sub-account is created
email	string	Optional	The email for the sub-account/location
id	string	Optional	Location Id
name	string	Optional	The name for the sub-account/location
phone	string	Optional	The phone number of the business for which sub-account is created
postalCode	string	Optional	The postal code of the business for which sub-account is created
settings	JSON	Optional	The default settings for location
settings (allOf 1)	Model	All variants apply	Expand Get Sub-Account (Formerly Location) — response body — location settings
social	JSON	Optional	The social media links for location
social (allOf 1)	Model	All variants apply	Expand Get Sub-Account (Formerly Location) — response body — location social
state	string	Optional	The state in which the business operates for which sub-account is created
timezone	string	Optional	The timezone of the business for which sub-account is created
website	string	Optional	The website of the business for which sub-account is created

Referenced models: Get Sub-Account (Formerly Location) — response body — location settings, Get Sub-Account (Formerly Location) — response body — location social

Get Sub-Account (Formerly Location) — response body — location settings

Field	Type	Presence	Description and constraints
$	object	Root
allowDuplicateContact	boolean	Optional
allowDuplicateOpportunity	boolean	Optional
allowFacebookNameMerge	boolean	Optional
disableContactTimezone	boolean	Optional

Get Sub-Account (Formerly Location) — response body — location social

Field	Type	Presence	Description and constraints
$	object	Root
blogRss	string	Optional	Instagram URL
facebookUrl	string	Optional	Facebook URL
foursquare	string	Optional	Foursquare URL
googlePlacesId	string	Optional	Google Business Places ID
googlePlus	string	Optional	Googleplus URL
instagram	string	Optional	Instagram URL
linkedIn	string	Optional	LinkedIn URL
pinterest	string	Optional	Instagram URL
twitter	string	Optional	Twitter URL
yelp	string	Optional	Yelp URL
youtube	string	Optional	Instagram URL

Policy, approvals and errors

SDK function policy ID: gohighlevel.search_locations. Catalog operation: search-locations. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["locations.readonly"]

Pinned headers: {"Version": "v3"}

Official provider source