HighLevel: Get Custom Menu Links

← Custom menus operations · Get started

Operation gohighlevel.get_custom_menus

Provider route: GET /custom-menus/. 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["customMenus"]["getCustomMenus"]>[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.customMenus.getCustomMenus(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.custom_menus.get_custom_menus(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.locationId	string	Optional
query.skip	number	Optional	Default: 0 Minimum: 0
query.limit	number	Optional	Default: 20 Minimum: 1
query.query	string	Optional
query.showOnCompany	boolean	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 Custom Menu Links — response body

Referenced models: Get Custom Menu Links — response body

Schemas

Get Custom Menu Links — response body

Field	Type	Presence	Description and constraints
$	object	Root
customMenus	array	Optional	Array of custom menu links
customMenus[]	Model	Each item	Expand Get Custom Menu Links — response body — custom Menus item
totalLinks	JSON	Optional
totalLinks (anyOf 1)	number	Alternative	Total number of custom menu records
totalLinks (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get Custom Menu Links — response body — custom Menus item

Get Custom Menu Links — response body — custom Menus item

Field	Type	Presence	Description and constraints
$	object	Root
allowCamera	boolean	Optional	Indicates if camera access is allowed for this menu
allowMicrophone	boolean	Optional	Indicates if microphone access is allowed for this menu
icon	JSON	Optional	Icon information for the menu item
icon (allOf 1)	Model	All variants apply	Expand Get Custom Menu Links — response body — customMenus / item / icon / fontFamily: fab, fas, far
id	string	Optional	Unique identifier for the custom menu
locations	array	Optional	List of sub-account IDs where the menu should be shown. This list is applicable only when showOnLocation is true and showToAllLocations is false
locations[]	string	Each item
openMode	string	Optional	Mode for opening the menu link Known values: iframe, new_tab, current_tab
order	JSON	Optional
order (anyOf 1)	number	Alternative	Order of the custom menu
order (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
showOnCompany	boolean	Optional	Filter to show only agency-level menu links. When omitted, fetches both agency and sub-account menu links. Ignored if locationId is provided
showOnLocation	boolean	Optional	Whether the menu must be displayed for sub-accounts level
showToAllLocations	boolean	Optional	Whether the menu must be displayed to all sub-accounts
title	string	Optional	Title of the custom menu
url	string	Optional	URL of the custom menu
userRole	string	Optional	Which user-roles should the menu be accessible to? Known values: all, admin, user

Referenced models: Get Custom Menu Links — response body — customMenus / item / icon / fontFamily: fab, fas, far

Get Custom Menu Links — response body — customMenus / item / icon / fontFamily: fab, fas, far

Field	Type	Presence	Description and constraints
$	object	Root
fontFamily	string	Optional	Font family of the icon Known values: fab, fas, far
name	string	Optional	Name of the icon

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_custom_menus. Catalog operation: get-custom-menus. 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: ["custom-menu-link.readonly"]

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

Official provider source