> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # Return a list of Menu Items > Returns a list of Menu Items ## OpenAPI ````yaml /api-reference/platform.yaml get /api/v2/platform/menu_items openapi: 3.0.3 info: title: Platform API contact: name: Vendo Connect Inc. url: https://getvendo.com email: sales@getvendo.com description: Spree Platform API version: v2 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Addresses - name: Adjustments - name: Classifications - name: Countries - name: CMS Pages - name: CMS Sections - name: Digital Assets - name: Digital Links - name: Line Items - name: Menus - name: Menu Items - name: Option Types - name: Option Values - name: Orders - name: Payments - name: Payment Methods - name: Products - name: Promotions - name: Promotion Actions - name: Promotion Categories - name: Promotion Rules - name: Roles - name: Shipments - name: Shipping Categories - name: Shipping Methods - name: States - name: Stock Items - name: Stock Locations - name: Store Credit Categories - name: Store Credit Types - name: Store Credits - name: Tax Categories - name: Tax Rates - name: Taxons - name: Taxonomies - name: Users - name: Variants - name: Vendors - name: Webhook Events - name: Webhook Subscribers - name: Wishlists - name: Wished Items - name: Zones paths: /api/v2/platform/menu_items: get: tags: - Menu Items summary: Return a list of Menu Items description: Returns a list of Menu Items operationId: menu-items-list parameters: - name: page in: query example: 1 schema: type: integer - name: per_page in: query example: 50 schema: type: integer - name: include in: query description: >- Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes example: menu,icon,parent,children,linked_resource schema: type: string - name: filter[name_eq] in: query description: '' example: T-Shirts schema: type: string responses: '200': description: Records returned content: application/vnd.api+json: examples: Example: value: data: - id: '2' type: menu_item attributes: name: Link no. 1 To Somewhere subtitle: null destination: null new_window: false item_type: Link linked_resource_type: Spree::Linkable::Uri code: null lft: 2 rgt: 3 depth: 1 created_at: '2022-11-08T19:34:23.401Z' updated_at: '2022-11-08T19:34:23.404Z' link: null is_container: false is_root: false is_child: true is_leaf: true relationships: icon: data: id: '13' type: icon menu: data: id: '1' type: menu parent: data: id: '1' type: menu_item linked_resource: data: null children: data: [] - id: '3' type: menu_item attributes: name: Link no. 2 To Somewhere subtitle: null destination: null new_window: false item_type: Link linked_resource_type: Spree::Linkable::Uri code: null lft: 4 rgt: 5 depth: 1 created_at: '2022-11-08T19:34:23.425Z' updated_at: '2022-11-08T19:34:23.428Z' link: null is_container: false is_root: false is_child: true is_leaf: true relationships: icon: data: id: '14' type: icon menu: data: id: '1' type: menu parent: data: id: '1' type: menu_item linked_resource: data: null children: data: [] - id: '4' type: menu_item attributes: name: Link no. 3 To Somewhere subtitle: null destination: null new_window: false item_type: Link linked_resource_type: Spree::Linkable::Uri code: null lft: 6 rgt: 7 depth: 1 created_at: '2022-11-08T19:34:23.446Z' updated_at: '2022-11-08T19:34:23.449Z' link: null is_container: false is_root: false is_child: true is_leaf: true relationships: icon: data: id: '15' type: icon menu: data: id: '1' type: menu parent: data: id: '1' type: menu_item linked_resource: data: null children: data: [] - id: '5' type: menu_item attributes: name: Link no. 4 To Somewhere subtitle: null destination: null new_window: false item_type: Link linked_resource_type: Spree::Linkable::Uri code: null lft: 8 rgt: 9 depth: 1 created_at: '2022-11-08T19:34:23.468Z' updated_at: '2022-11-08T19:34:23.471Z' link: null is_container: false is_root: false is_child: true is_leaf: true relationships: icon: data: id: '16' type: icon menu: data: id: '1' type: menu parent: data: id: '1' type: menu_item linked_resource: data: null children: data: [] - id: '6' type: menu_item attributes: name: Link no. 5 To Somewhere subtitle: null destination: null new_window: false item_type: Link linked_resource_type: Spree::Linkable::Uri code: null lft: 10 rgt: 11 depth: 1 created_at: '2022-11-08T19:34:23.491Z' updated_at: '2022-11-08T19:34:23.494Z' link: null is_container: false is_root: false is_child: true is_leaf: true relationships: icon: data: id: '17' type: icon menu: data: id: '1' type: menu parent: data: id: '1' type: menu_item linked_resource: data: null children: data: [] - id: '7' type: menu_item attributes: name: Link no. 6 To Somewhere subtitle: null destination: null new_window: false item_type: Link linked_resource_type: Spree::Linkable::Uri code: null lft: 12 rgt: 13 depth: 1 created_at: '2022-11-08T19:34:23.515Z' updated_at: '2022-11-08T19:34:23.518Z' link: null is_container: false is_root: false is_child: true is_leaf: true relationships: icon: data: id: '18' type: icon menu: data: id: '1' type: menu parent: data: id: '1' type: menu_item linked_resource: data: null children: data: [] - id: '8' type: menu_item attributes: name: Link no. 7 To Somewhere subtitle: null destination: null new_window: false item_type: Link linked_resource_type: Spree::Linkable::Uri code: null lft: 14 rgt: 15 depth: 1 created_at: '2022-11-08T19:34:23.535Z' updated_at: '2022-11-08T19:34:23.537Z' link: null is_container: false is_root: false is_child: true is_leaf: true relationships: icon: data: id: '19' type: icon menu: data: id: '1' type: menu parent: data: id: '1' type: menu_item linked_resource: data: null children: data: [] - id: '1' type: menu_item attributes: name: Neque a rem deserunt beatae. subtitle: null destination: null new_window: false item_type: Container linked_resource_type: Spree::Linkable::Uri code: null lft: 1 rgt: 16 depth: 0 created_at: '2022-11-08T19:34:23.379Z' updated_at: '2022-11-08T19:34:23.545Z' link: null is_container: true is_root: true is_child: false is_leaf: false relationships: icon: data: null menu: data: id: '1' type: menu parent: data: null linked_resource: data: null children: data: - id: '2' type: menu_item - id: '3' type: menu_item - id: '4' type: menu_item - id: '5' type: menu_item - id: '6' type: menu_item - id: '7' type: menu_item - id: '8' type: menu_item meta: count: 8 total_count: 8 total_pages: 1 links: self: >- http://www.example.com/api/v2/platform/menu_items?page=1&per_page=&include=&filter[name_eq]= next: >- http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page= prev: >- http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page= last: >- http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page= first: >- http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page= schema: $ref: '#/components/schemas/resources_list' '401': description: Authentication Failed content: application/vnd.api+json: examples: Example: value: error: The access token is invalid schema: $ref: '#/components/schemas/error' security: - bearer_auth: [] components: schemas: resources_list: type: object properties: data: type: array items: allOf: - $ref: '#/components/schemas/resource_properties' meta: type: object properties: count: type: integer total_count: type: integer total_pages: type: integer required: - count - total_count - total_pages links: type: object properties: self: type: string next: type: string prev: type: string last: type: string first: type: string required: - self - next - prev - last - first required: - data - meta - links x-internal: false error: type: object properties: error: type: string required: - error x-internal: false resource_properties: type: object properties: id: type: string type: type: string attributes: type: object relationships: type: object required: - id - type - attributes x-internal: false securitySchemes: bearer_auth: type: http scheme: bearer ````