GET
/
api
/
v2
/
platform
/
menus
Return a list of Menus
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/menus \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "18",
      "type": "menu",
      "attributes": {
        "name": "Main Menu",
        "location": "header",
        "locale": "en",
        "created_at": "2022-11-08T19:34:28.349Z",
        "updated_at": "2022-11-08T19:34:28.398Z"
      },
      "relationships": {
        "menu_items": {
          "data": [
            {
              "id": "89",
              "type": "menu_item"
            },
            {
              "id": "90",
              "type": "menu_item"
            },
            {
              "id": "87",
              "type": "menu_item"
            }
          ]
        }
      }
    },
    {
      "id": "19",
      "type": "menu",
      "attributes": {
        "name": "Footer Menu",
        "location": "footer",
        "locale": "en",
        "created_at": "2022-11-08T19:34:28.357Z",
        "updated_at": "2022-11-08T19:34:28.448Z"
      },
      "relationships": {
        "menu_items": {
          "data": [
            {
              "id": "91",
              "type": "menu_item"
            },
            {
              "id": "92",
              "type": "menu_item"
            },
            {
              "id": "88",
              "type": "menu_item"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/menus?page=1&per_page=&include=&filter[name_eq]=&filter[location_eq]=",
    "next": "http://www.example.com/api/v2/platform/menus?filter%5Blocation_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/menus?filter%5Blocation_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/menus?filter%5Blocation_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/menus?filter%5Blocation_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page="
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
​
per_page
integer
​
include
string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

​
filter[name_eq]
string
​
filter[location_eq]
string

Response

200
application/vnd.api+json

Records returned

The response is of type object.