HighLevel: Get Installer Details

HighLevel marketplace.getInstallerDetails: arguments, response, policy and SDK examples.

Operation gohighlevel.get_installer_details

Provider route: GET /marketplace/app/{appId}/installations. 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["marketplace"]["getInstallerDetails"]>[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.marketplace.getInstallerDetails(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.marketplace.get_installer_details(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.appId`	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 Installer Details — response body

Referenced models: Get Installer Details — response body

Schemas

Get Installer Details — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`installationDetails`	JSON	Required within parent	Installation details
`installationDetails (allOf 1)`	Model	All variants apply	Expand Get Installer Details — response body — installation Details company Email, company High Level Plan, company Id, company Name, company Owner Full Name, company Plan, is Whitelabel Company, location Id, marketplace App Plan Id, relationship Number, user Id, whitelabel Details

Referenced models: Get Installer Details — response body — installation Details company Email, company High Level Plan, company Id, company Name, company Owner Full Name, company Plan, is Whitelabel Company, location Id, marketplace App Plan Id, relationship Number, user Id, whitelabel Details

Get Installer Details — response body — installation Details company Email, company High Level Plan, company Id, company Name, company Owner Full Name, company Plan, is Whitelabel Company, location Id, marketplace App Plan Id, relationship Number, user Id, whitelabel Details

Field	Type	Presence	Description and constraints
`$`	object	Root
`companyEmail`	JSON	Optional
`companyEmail (anyOf 1)`	string	Alternative	Company email. Will be null for sub-account installations due to PII concerns.
`companyEmail (anyOf 2)`	null	Alternative
`companyHighLevelPlan`	JSON	Optional
`companyHighLevelPlan (anyOf 1)`	string	Alternative	Company plan. Will be null for sub-account installations due to business sensitivity.
`companyHighLevelPlan (anyOf 2)`	null	Alternative
`companyId`	string	Required within parent	Company ID
`companyName`	string	Required within parent	Company name
`companyOwnerFullName`	JSON	Optional
`companyOwnerFullName (anyOf 1)`	string	Alternative	Company owner full name. Will be null for sub-account installations due to PII concerns.
`companyOwnerFullName (anyOf 2)`	null	Alternative
`companyPlan`	JSON	Optional
`companyPlan (anyOf 1)`	string	Alternative	Company plan. Will be null for sub-account installations due to business sensitivity.
`companyPlan (anyOf 2)`	null	Alternative
`isWhitelabelCompany`	boolean	Required within parent	Whether the company is a whitelabel company
`locationId`	string	Optional	Location ID (if applicable)
`marketplaceAppPlanId`	string	Optional	Marketplace app plan ID for paid apps
`relationshipNumber`	string	Required within parent	Company relationship number
`userId`	string	Required within parent	User ID who installed the app
`whitelabelDetails`	JSON	Optional	Whitelabel details (only present if isWhitelabelCompany is true)
`whitelabelDetails (allOf 1)`	Model	All variants apply	Expand Get Installer Details — response body — installation Details company Email, company High Level Plan, company Id, company Name, company Owner Full Name, company Plan, is Whitelabel Company, location Id, marketplace App Plan Id, relationship Number, user Id, whitelabel Details whitelabel Details domain, logo Url

Field	Type	Presence	Description and constraints
`$`	object	Root
`domain`	string	Required within parent	Domain of the whitelabel company
`logoUrl`	string	Required within parent	Logo URL of the whitelabel company

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_installer_details. Catalog operation: get-installer-details. 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: ["marketplace-installer-details.readonly"]

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

Official provider source

Report an issue with this page