HighLevel: Get Available Accounts (Step 2 of 3)

HighLevel socialPlanner.getOauthAccounts: arguments, response, policy and SDK examples.

← Social planner operations · Get started

Operation gohighlevel.get_oauth_accounts

Provider route: GET /social-media-posting/oauth/{locationId}/{platform}/accounts/{accountId}. 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"]["getOauthAccounts"]>[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.getOauthAccounts(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_oauth_accounts(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
`path.platform`	string	Required within parent	One of: google, facebook, instagram, linkedin, tiktok, tiktok-business, youtube, pinterest, threads, bluesky
`path.accountId`	string	Required within parent
`query`	object	Optional	Additional keys: not allowed
`query.search`	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
`$`	JSON	Root
`$ (anyOf 1)`	Model	Alternative	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Facebook Accounts Response DTO
`$ (anyOf 2)`	Model	Alternative	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Instagram Accounts Response DTO
`$ (anyOf 3)`	Model	Alternative	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Google Location Response DTO
`$ (anyOf 4)`	Model	Alternative	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Linked In Accounts Response DTO
`$ (anyOf 5)`	Model	Alternative	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Tiktok Account Response DTO
`$ (anyOf 6)`	Model	Alternative	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Tiktok Business Account Response DTO
`$ (anyOf 7)`	Model	Alternative	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get You Tube Accounts Response DTO
`$ (anyOf 8)`	Model	Alternative	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Pinterest Accounts Response DTO

Referenced models: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Facebook Accounts Response DTO, Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Google Location Response DTO, Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Instagram Accounts Response DTO, Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Linked In Accounts Response DTO, Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Pinterest Accounts Response DTO, Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Tiktok Account Response DTO, Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Tiktok Business Account Response DTO, Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get You Tube Accounts Response DTO

Schemas

16 more schemas are linked from the tables above, on the schema pages.

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Facebook Accounts Response DTO

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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages
`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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Google Location Response DTO

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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results locations
`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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results locations

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Instagram Accounts Response DTO

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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results accounts
`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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results accounts

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Linked In Accounts Response DTO

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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages, profile
`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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages, profile

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Pinterest Accounts Response DTO

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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Pinterest Account Schema
`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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Pinterest Account Schema

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Tiktok Account Response DTO

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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Tiktok Account Schema
`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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Tiktok Account Schema

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get Tiktok Business Account Response DTO

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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Tiktok Business Account Schema
`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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Tiktok Business Account Schema

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success — Get You Tube Accounts Response DTO

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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Youtube Account Schema
`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 Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results profile — Get Youtube Account Schema

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages

Field	Type	Presence	Description and constraints
`$`	object	Root
`pages`	array	Optional	Facebook Pages Details
`pages[]`	Model	Each item	Expand Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages pages item

Referenced models: Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages pages item

Get Available Accounts (Step 2 of 3) — response body — message, results, status Code, success results pages pages item

Field	Type	Presence	Description and constraints
`$`	object	Root
`avatar`	string	Optional	Avatar or profile picture URL of the page
`id`	string	Optional	Facebook page identifier
`isConnected`	boolean	Optional	Indicates if the page is currently connected
`isOwned`	boolean	Optional	Indicates if the user owns this page
`name`	string	Optional	Name of the Facebook page

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_oauth_accounts. Catalog operation: get-oauth-accounts. 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

Report an issue with this page