XM
Members
Retrieve Live Menu List by Channel ID
This documentation is now outdated, please find the latest docs for this endpoint here
Retrieves main menus and their nested sub-menus on your site, by channel ID.
Along with the channel ID, you may optionally specify the nodeId or the parentId as query parameters to narrow down the search results.
Path:
1
GET https://{baseurl}/api-xpm/v2/menu/live/
Copied!

Headers

Content-Type : application/json
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }

Parameters

Type : query
Name : The channel ID.
Required: true
Type : query
Name : The nodeId (an optional parameter to specify the root of the subtree) or the parentId (an optional parameter to specify the parent node of the one or more subtree.)
Required: false
1
GET https://{baseurl}/api-xpm/v2/menu/live/?channelId=12&nodeId=60dce82e3b5d307719fb0522
Copied!
Response Code: 200
Message: OK
Description: You will see this message when the menus and the nested sub-menus are successfully retrieved.
1
{
2
"query": {
3
"channelId": "12",
4
"nodeId": "60dce82e3b5d307719fb0522"
5
},
6
"menu": [
7
{
8
"url": "/",
9
"name": "123",
10
"order": 0,
11
"nodeId": "60dce82e3b5d307719fb0522",
12
"parentId": "60dce8213b5d307719fb0521"
13
}
14
]
15
}
Copied!

Change Log

  • Jun - 2021 (multichannel features)
Last modified 1mo ago
Copy link
Contents
Change Log