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.

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

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Query parameters

string

default:"5DP4iH6HLkQsiKESj6rh"

Unique identifier of the account

number

default:"0"

Number of items to skip for pagination

number

default:"10"

Maximum number of items to return

string

default:"custom-menu-link-name"

Search query to filter custom menus by name, supports partial || full names

boolean

default:"True"

Filter to show only agency-level menu links. When omitted, fetches both agency and account menu links. Ignored if locationId is provided

Respuestas

200 - Successfully retrieved custom menus. Returns an array of custom menu objects, potentially including their structure, items, and relevant metadata.

object[]

Array of custom menu links

Show cada item

string

default:"12345"

Unique identifier for the custom menu

object

Icon information for the menu item

string

default:"Dashboard"

Title of the custom menu

string

default:"/dashboard"

URL of the custom menu

number

default:"1"

Order of the custom menu

boolean

default:"True"

Filter to show only agency-level menu links. When omitted, fetches both agency and account menu links. Ignored if locationId is provided

boolean

default:"True"

Whether the menu must be displayed for accounts level

boolean

default:"True"

Whether the menu must be displayed to all accounts

string[]

List of account IDs where the menu should be shown. This list is applicable only when showOnLocation is true and showToAllLocations is false

string

Mode for opening the menu link Posibles valores: ‘iframe’, ‘new_tab’, ‘current_tab’

string

Which user-roles should the menu be accessible to? Posibles valores: ‘all’, ‘admin’, ‘user’

boolean

default:"False"

Indicates if camera access is allowed for this menu

boolean

default:"False"

Indicates if microphone access is allowed for this menu

number

default:"100"

Total number of custom menu records

{
  "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

{}

403 - Forbidden. The client does not have necessary permissions to access custom menus.

422 - Unprocessable Entity

{}

Ejemplo

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

const response = await fetch('https://services.leadconnectorhq.com/custom-menus/', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
  },
});
const data = await response.json();

import os, requests
response = requests.request(
    'GET',
    'https://services.leadconnectorhq.com/custom-menus/',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/custom-menus/');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
    ],
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Get Custom Menu Links

Autorización

Query parameters

Respuestas

Ejemplo

​Autorización

​Query parameters

​Respuestas

​Ejemplo

Autorización

Query parameters

Respuestas

Ejemplo