HighLevel: Get Location where app is installed

← Oauth operations · Get started

Operation gohighlevel.get_installed_location

Provider route: GET /oauth/installed-locations. 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["oauth"]["getInstalledLocation"]>[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.oauth.getInstalledLocation(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.oauth.get_installed_location(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.pageSize	number	Optional	Default: 20
query.pageToken	string	Optional
query.query	string	Optional
query.isInstalled	boolean	Optional
query.restrictToUserLocations	boolean	Optional
query.companyId	string	Required within parent
query.appId	string	Required within parent
query.versionId	string	Optional
query.onTrial	boolean	Optional
query.planId	string	Optional
query.locationId	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 Get Location where app is installed — response body

Referenced models: Get Location where app is installed — response body

Schemas

Get Location where app is installed — response body

Field	Type	Presence	Description and constraints
$	object	Root
installToFutureLocations	boolean	Optional	Boolean to control if user wants app to be automatically installed to future locations
items	array	Required within parent	List of locations with their installation status for the requested app
items[]	Model	Each item	Expand Get Location where app is installed — response body — items item
metadata	JSON	Optional	Query metadata (filters and sort applied)
metadata (allOf 1)	Model	All variants apply	Expand Get Location where app is installed — response body — metadata filter Applied, sort Applied
pagination	JSON	Required within parent	Pagination metadata (AIP-158)
pagination (allOf 1)	Model	All variants apply	Expand Get Location where app is installed — response body — pagination current Page Size, estimated Total Records, has Next Page, has Prev Page, next Page Token, prev Page Token, total Records

Referenced models: Get Location where app is installed — response body — items item, Get Location where app is installed — response body — metadata filter Applied, sort Applied, Get Location where app is installed — response body — pagination current Page Size, estimated Total Records, has Next Page, has Prev Page, next Page Token, prev Page Token, total Records

Get Location where app is installed — response body — items item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Location ID
address	string	Required within parent	Address linked to location
installedAt	string	Optional	Timestamp when the app was installed on this location Format: date-time
isInstalled	boolean	Optional	Check if the requested app is installed for following location
name	string	Required within parent	Name of the location
versionId	string	Optional	Version ID of the installed app version for this location

Get Location where app is installed — response body — metadata filter Applied, sort Applied

Field	Type	Presence	Description and constraints
$	object	Root
filterApplied	object	Optional	Filters that were applied to the query Additional keys: allowed
sortApplied	object	Optional	Sort order that was applied to the query Additional keys: allowed

Get Location where app is installed — response body — pagination current Page Size, estimated Total Records, has Next Page, has Prev Page, next Page Token, prev Page Token, total Records

Field	Type	Presence	Description and constraints
$	object	Root
currentPageSize	JSON	Required within parent
currentPageSize (anyOf 1)	number	Alternative	Number of items returned in the current page
currentPageSize (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
estimatedTotalRecords	JSON	Optional
estimatedTotalRecords (anyOf 1)	number	Alternative	Estimated total records; present when exact total is unknown
estimatedTotalRecords (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hasNextPage	boolean	Required within parent	True when a next page is available
hasPrevPage	boolean	Required within parent	True when a previous page is available
nextPageToken	string	Optional	Opaque token to fetch the next page
prevPageToken	string	Optional	Opaque token to fetch the previous page
totalRecords	JSON	Optional
totalRecords (anyOf 1)	number	Alternative	Total number of records matching the query across all pages
totalRecords (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_installed_location. Catalog operation: get-installed-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: ["oauth.readonly"]

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

Official provider source