Skip to main content
GET
/
menu
Retrieves Menu List
curl --request GET \
  --url https://cdn.xm.fabric.inc/api/menu \
  --header 'x-site-context: <x-site-context>'
{
  "status_code": 123,
  "status": "<string>",
  "data": {
    "menus": [
      {
        "_id": "<string>",
        "channel": [
          123
        ],
        "channels": [
          "<string>"
        ],
        "name": "<string>",
        "label": "<string>",
        "path": "<string>",
        "isActive": true,
        "images": [
          {
            "order": 123,
            "meta": "<string>",
            "label": "<string>",
            "kind": "<string>",
            "url": "<string>"
          }
        ],
        "videos": [
          {
            "label": "<string>",
            "order": 123,
            "url": "<string>",
            "provider": "<string>",
            "thumbnails": [
              {
                "size": "<string>",
                "url": "<string>"
              }
            ]
          }
        ],
        "params": [
          {
            "_id": "<string>",
            "kind": "<string>",
            "value": "<string>"
          }
        ],
        "order": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "__v": 123,
        "children": [
          {
            "_id": "<string>",
            "channel": [
              123
            ],
            "channels": [
              "<string>"
            ],
            "name": "<string>",
            "label": "<string>",
            "path": "<string>",
            "isActive": true,
            "images": [
              {
                "order": 123,
                "meta": "<string>",
                "label": "<string>",
                "kind": "<string>",
                "url": "<string>"
              }
            ],
            "videos": [
              {
                "label": "<string>",
                "order": 123,
                "url": "<string>",
                "provider": "<string>",
                "thumbnails": [
                  {
                    "size": "<string>",
                    "url": "<string>"
                  }
                ]
              }
            ],
            "params": [
              {
                "_id": "<string>",
                "kind": "<string>",
                "value": "<string>"
              }
            ],
            "order": 123,
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "__v": 123
          }
        ]
      }
    ]
  }
}

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Response

Successful operation

200 response object

​
status_code
integer

The response status code

​
status
string

Status message

​
data
object

The data object holding the list of menus