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
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
Authorization | string | Yes | Bearer token generated from the Leadway portal. See Authentication. | |
Version | string | Yes | 2021-07-28 | API version. |
Query parameters
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
locationId | string | No | 5DP4iH6HLkQsiKESj6rh | Unique identifier of the account |
skip | number | No | 0 | Number of items to skip for pagination |
limit | number | No | 10 | Maximum number of items to return |
query | string | No | custom-menu-link-name | Search query to filter custom menus by name, supports partial || full names |
showOnCompany | boolean | No | True | Filter to show only agency-level menu links. When omitted, fetches both agency and account menu links. Ignored if locationId is provided |
Responses
400 - Bad Request. Invalid query parameters provided.
422 - Unprocessable Entity
json
{}Example
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);