HighLevel: Get Accounts

← Social planner operations · Get started

Operation gohighlevel.get_account

Provider route: GET /social-media-posting/{locationId}/accounts. 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["socialPlanner"]["getAccount"]>[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.socialPlanner.getAccount(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.social_planner.get_account(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 Accounts — response body

Referenced models: Get Accounts — response body

Schemas

Get Accounts — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Optional	Requested Results
results (allOf 1)	Model	All variants apply	Expand Get Accounts — response body — results accounts, groups
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Referenced models: Get Accounts — response body — results accounts, groups

Get Accounts — response body — results accounts, groups

Field	Type	Presence	Description and constraints
$	object	Root
accounts	array	Optional	Array of connected social media accounts
accounts[]	Model	Each item	Expand Get Accounts — response body — results accounts, groups accounts item
groups	array	Optional	Array of account groups
groups[]	Model	Each item	Expand Get Accounts — response body — results accounts, groups groups item

Referenced models: Get Accounts — response body — results accounts, groups accounts item, Get Accounts — response body — results accounts, groups groups item

Get Accounts — response body — results accounts, groups accounts item

Field	Type	Presence	Description and constraints
$	object	Root
expire	string	Optional	Token expiration date and time
id	string	Optional	Unique identifier for the connected account
isExpired	boolean	Optional	Indicates if the account token has expired
meta	object	Optional	Additional metadata for the account
name	string	Optional	Display name of the account
oauthId	string	Optional	OAuth provider account identifier
platform	string	Optional	platform must be one of the following values: google, facebook, instagram, linkedin, tiktok
profileId	string	Optional	Profile identifier from the social media platform
type	string	Optional	Type of account (e.g., location, page, profile)

Get Accounts — response body — results accounts, groups groups item

Field	Type	Presence	Description and constraints
$	object	Root
accountIds	array	Required within parent	Array of account IDs belonging to this group
accountIds[]	string	Each item
id	string	Required within parent	Group Id
name	string	Required within parent	name of group

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_account. Catalog operation: get-account. 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: ["socialplanner/account.readonly"]

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

Official provider source