HighLevel: Get Sub-Account (Formerly Location)

← Locations operations · Get started

Operation gohighlevel.get_location

Provider route: GET /locations/{locationId}. 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"]["getLocation"]>[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.getLocation(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.get_location(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.locationId	string	Required within parent

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 Get Sub-Account (Formerly Location) — response body

Referenced models: Get Sub-Account (Formerly Location) — response body

Schemas

Get Sub-Account (Formerly Location) — response body

Field	Type	Presence	Description and constraints
$	object	Root
location	Model	Optional	Expand Get Sub-Account (Formerly Location) — response body — location

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

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

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional
business	Model	Optional	Expand Get Sub-Account (Formerly Location) — response body — location business
city	string	Optional
companyId	string	Optional
country	string	Optional
domain	string	Optional
email	string	Optional
firstName	string	Optional
id	string	Optional
lastName	string	Optional
logoUrl	string	Optional
name	string	Optional
phone	string	Optional
postalCode	string	Optional
reseller	object	Optional
settings	Model	Optional	Expand Get Sub-Account (Formerly Location) — response body — location settings
social	Model	Optional	Expand Get Sub-Account (Formerly Location) — response body — location social
state	string	Optional
timezone	string	Optional
website	string	Optional

Referenced models: Get Sub-Account (Formerly Location) — response body — location business, 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 business

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional
city	string	Optional
country	string	Optional
logoUrl	string	Optional
name	string	Optional
postalCode	string	Optional
state	string	Optional
timezone	string	Optional
website	string	Optional

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.get_location. Catalog operation: get-location. 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