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.

http
GET https://services.leadconnectorhq.com/custom-menus/

Authorization

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Query parameters

NameTypeRequiredExampleDescription
locationIdstringNo5DP4iH6HLkQsiKESj6rhUnique identifier of the account
skipnumberNo0Number of items to skip for pagination
limitnumberNo10Maximum number of items to return
querystringNocustom-menu-link-nameSearch query to filter custom menus by name, supports partial || full names
showOnCompanybooleanNoTrueFilter to show only agency-level menu links. When omitted, fetches both agency and account menu links. Ignored if locationId is provided

Responses

200 - Successfully retrieved custom menus. Returns an array of custom menu objects, potentially including their structure, items, and relevant metadata.
  • customMenus (object[]): Array of custom menu links

    • id (string): Unique identifier for the custom menu Example: 12345

    • icon (object): Icon information for the menu item

    • title (string): Title of the custom menu Example: Dashboard

    • url (string): URL of the custom menu Example: /dashboard

    • order (number): Order of the custom menu Example: 1

    • showOnCompany (boolean): Filter to show only agency-level menu links. When omitted, fetches both agency and account menu links. Ignored if locationId is provided Example: True

    • showOnLocation (boolean): Whether the menu must be displayed for accounts level Example: True

    • showToAllLocations (boolean): Whether the menu must be displayed to all accounts Example: True

    • locations (string[]): List of account IDs where the menu should be shown. This list is applicable only when showOnLocation is true and showToAllLocations is false

    • openMode (string): Mode for opening the menu link Possible values: 'iframe', 'new_tab', 'current_tab'

    • userRole (string): Which user-roles should the menu be accessible to? Possible values: 'all', 'admin', 'user'

    • allowCamera (boolean): Indicates if camera access is allowed for this menu Example: False

    • allowMicrophone (boolean): Indicates if microphone access is allowed for this menu Example: False

  • totalLinks (number): Total number of custom menu records Example: 100

json
{
  "customMenus": [
    {
      "id": "12345",
      "title": "Dashboard",
      "url": "/dashboard",
      "order": 1,
      "showOnCompany": true,
      "showOnLocation": true,
      "showToAllLocations": true,
      "locations": [
        "gfWreTIHL8pDbggBb7af",
        "67WreTIHL8pDbggBb7ty"
      ],
      "openMode": "iframe",
      "userRole": "all",
      "allowCamera": false,
      "allowMicrophone": false
    }
  ],
  "totalLinks": 100
}
400 - Bad Request. Invalid query parameters provided.
401 - Unauthorized
json
{}
403 - Forbidden. The client does not have necessary permissions to access custom menus.
422 - Unprocessable Entity
json
{}

Example

curl -X GET 'https://services.leadconnectorhq.com/custom-menus/' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

Last updated October 26, 2026

Was this page helpful?