ghl_custom_menu_list
Fetches custom menu links with name search, location or agency-level filtering, and pagination to browse complete results.
Instructions
REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only for all custom-menus ops. Get Custom Menu Links Fetches a collection of custom menus based on specified criteria. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and associated metadata. The response can be tailored using query parameters for filtering, sorting, and pagination. Endpoint: GET /custom-menus/ (Version header: v3; source: v3/custom-menus-v3.json) Requires an Agency (company-level) token. OAuth scopes: custom-menu-link.readonly Pagination params: skip, limit — pass them to page through full result sets.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "ghl_custom_menu_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skip | No | Number of items to skip for pagination | |
| limit | No | Maximum number of items to return | |
| query | No | Search query to filter custom menus by name, supports partial || full names | |
| locationId | No | Unique identifier of the location | |
| showOnCompany | No | Filter to show only agency-level menu links. When omitted, fetches both agency and sub-account menu links. Ignored if locationId is provided |