HighLevel: Get Saa S Locations — saas get Saas Locations Deprecated

← Saas operations · Get started

Operation gohighlevel.get_saas_locations_deprecated

Provider route: GET /saas-api/public-api/saas-locations/{companyId}. 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["saas"]["getSaasLocationsDeprecated"]>[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.saas.getSaasLocationsDeprecated(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.saas.get_saas_locations_deprecated(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.companyId	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.page	number	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 Saa S Locations — saas get Saas Locations Deprecated — response body

Referenced models: Get Saa S Locations — saas get Saas Locations Deprecated — response body

Schemas

Get Saa S Locations — saas get Saas Locations Deprecated — response body

Field	Type	Presence	Description and constraints
$	object	Root
locations	array	Required within parent	Array of SaaS locations
locations[]	Model	Each item	Expand Get Saa S Locations — saas get Saas Locations Deprecated — response body — locations item
pagination	object	Required within parent
pagination.hasNext	boolean	Optional	Indicates if there is a next page
pagination.hasPrev	boolean	Optional	Indicates if there is a previous page
pagination.limit	JSON	Optional
pagination.limit (anyOf 1)	number	Alternative	Number of items per page
pagination.limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pagination.page	JSON	Optional
pagination.page (anyOf 1)	number	Alternative	Page number
pagination.page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pagination.total	JSON	Optional
pagination.total (anyOf 1)	number	Alternative	Total number of items
pagination.total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pagination.totalPages	JSON	Optional
pagination.totalPages (anyOf 1)	number	Alternative	Total number of pages
pagination.totalPages (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get Saa S Locations — saas get Saas Locations Deprecated — response body — locations item

Get Saa S Locations — saas get Saas Locations Deprecated — response body — locations item

Field	Type	Presence	Description and constraints
$	object	Root
companyId	string	Required within parent	Company ID
customerId	string	Optional	Customer ID
email	string	Optional	Email
isSaaSV2	boolean	Optional	Indicates if the SaaS is V2
locationId	string	Required within parent	Location ID
name	string	Optional	Name
providerLocationId	string	Optional	Provider location ID
saasMode	string	Required within parent	SaaS mode
subscriptionId	string	Required within parent	Subscription ID
subscriptionInfo	object	Optional	Subscription information

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_saas_locations_deprecated. Catalog operation: get-saas-locations-deprecated. 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.

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

Official provider source