Menus

Get Menus for a Channel

Required scope: public-api:read

Description

Menu items can be of three types:

  • uri for arbitrary URIs, mainly used for URLs
  • path for internal paths, such as when the menu item should link to an article or page
  • document is the same as path except it is used when routing is disabled
Curl Example
ACCESS_TOKEN=ey1234
curl -k -X GET "https://edit.livingdocs.io/proxy/api/api/v1/menus/:channelHandle" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Endpoint

GET api/v1/menus/:channelHandle

Parameters

Name Type Notes
:channelHandle string The handle of the channel for which you want to get the events.
?handle string Handle of the menu to retrieve.

Response

200
OK
api/v1/menus/web
[
  {
    "version": 8,
    "label": "My Menu",
    "maxDepth": 1,
    "nodes": [
      {
        "id": "11111111-0601-4c2b-a3b5-4da19b6d3bde",
        "label": "My Index",
        "path": "/",
        "type": "uri",
        "target": "_self",
        "nodes": [
          {
            "id": "22222222-0601-4c2b-a3b5-4da19b6d3bde",
            "documentId": 71,
            "label": "Other Page",
            "type": "path",
            "path": "/page/some-other-page",
            "nodes": []
          }
        ]
      },
      {
        "id": "33333333-0601-4c2b-a3b5-4da19b6d3bde",
        "label": "Arbitrary URL",
        "type": "uri",
        "uri": "http://example.com",
        "nodes": []
      },
      {
        "id": "44444444-0601-4c2b-a3b5-4da19b6d3bde",
        "label": "Other But External URL Link",
        "type": "uri",
        "uri": "http://foo.bar",
        "target": "_blank",
        "nodes": []
      }
    ]
  }
]