HighLevel: Get Business

← Businesses operations · Get started

Operation gohighlevel.get_business

Provider route: GET /businesses/{businessId}. 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["businesses"]["getBusiness"]>[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.businesses.getBusiness(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.businesses.get_business(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.businessId	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 Business — response body

Referenced models: Get Business — response body

Schemas

Get Business — response body

Field	Type	Presence	Description and constraints
$	object	Root
business	JSON	Required within parent	Business Response
business (allOf 1)	Model	All variants apply	Expand Get Businesses by Location — response body — businesses item

Referenced models: Get Businesses by Location — response body — businesses item

Get Businesses by Location — response body — businesses item

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	address
city	string	Optional	city
country	string	Optional	country
createdAt	string	Optional	Creation Time Format: date-time
createdBy	JSON	Optional	Created By
createdBy (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
description	string	Optional	description
email	string	Optional	email
id	string	Required within parent	Business Id
locationId	string	Required within parent	locaitonId
name	string	Required within parent	Business Name
phone	string	Optional	phone number
postalCode	string	Optional	postal code
state	string	Optional	state
updatedAt	string	Optional	Last updation time Format: date-time
updatedBy	JSON	Optional	updated By
updatedBy (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
website	string	Optional	website

Referenced models: Delete Event — request body — body

Delete Event — request body — body

Field	Type	Presence	Description and constraints
$	object	Root

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_business. Catalog operation: get-business. 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: ["businesses.readonly"]

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

Official provider source