---
title: "MenuItemList"
method: GET
path: "/menu-items"
tags: ["MenuItemList"]
---

# MenuItemList

`GET /menu-items`

## Query parameters

- `fields` string[]
- `filters` string[]

## Headers

- `Api-Version` 2, required
- `Api-Application` string, required
- `Api-Company` string, required
- `Api-Branding` string

## Response `200`

Success response. Data could be an object instead of a list when one value is returned

- object
  - `status` string, required
  - `type` string, required
  - `moreAfter` string, nullable
  - `data` object[], required
    - `publicId` string
    - `name` string, nullable
    - `page` object, nullable
      - `publicId` string
      - `name` string
      - `applicationType` 'sheet' | 'card' | 'report'
      - `company` object
        - `publicId` string
      - `group` object, nullable
        - `publicId` string
      - `draft` object
        - `publicId` string
        - `page` object
          - `publicId` string
        - `title` string, nullable
        - `components` object[]
          - `publicId` string
          - `pageVersion` object
            - `publicId` string
          - `template` object
            - `publicId` string
          - `boundVersion` object, nullable
            - `template` object
              - …
            - `publicId` string
            - `number` string
            - `mainPath` string
            - `notes` string, nullable
            - `publishedOn` string, date-time, nullable
            - `createdOn` string, date-time
            - `createdBy` object
              - …
          - `dimensions` union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
          - `inputs` string
          - `pagePage` object, nullable
            - `publicId` string
            - `pageVersion` object
              - …
            - `order` integer
        - `previewAgent` object, nullable
          - `publicId` string
        - `previewAsset` object, nullable
          - `publicId` string
        - `periodSpec` string, nullable
        - `periodSelectorEnabled` boolean
        - `defaultRefreshRate` integer, nullable
        - `createdOn` string, date-time
        - `createdBy` object, nullable
          - `publicId` string
          - `name` string
        - `updatedOn` string, date-time, nullable
        - `updatedBy` object, nullable
          - `publicId` string
          - `name` string
        - `pagePages` object[]
          - `publicId` string
          - `pageVersion` object
            - `publicId` string
          - `order` integer
        - `custom` object
      - `published` object
        - `publicId` string
        - `page` object
          - `publicId` string
        - `title` string, nullable
        - `components` object[]
          - `publicId` string
          - `pageVersion` object
            - `publicId` string
          - `template` object
            - `publicId` string
          - `boundVersion` object, nullable
            - `template` object
              - …
            - `publicId` string
            - `number` string
            - `mainPath` string
            - `notes` string, nullable
            - `publishedOn` string, date-time, nullable
            - `createdOn` string, date-time
            - `createdBy` object
              - …
          - `dimensions` union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
          - `inputs` string
          - `pagePage` object, nullable
            - `publicId` string
            - `pageVersion` object
            - `order` integer
        - `previewAgent` object, nullable
          - `publicId` string
        - `previewAsset` object, nullable
          - `publicId` string
        - `periodSpec` string, nullable
        - `periodSelectorEnabled` boolean
        - `defaultRefreshRate` integer, nullable
        - `createdOn` string, date-time
        - `createdBy` object, nullable
          - `publicId` string
          - `name` string
        - `updatedOn` string, date-time, nullable
        - `updatedBy` object, nullable
          - `publicId` string
          - `name` string
        - `pagePages` object[]
          - `publicId` string
          - `pageVersion` object
          - `order` integer
        - `custom` object
      - `default` boolean
      - `static` boolean
      - `orientation` 'portrait' | 'landscape', nullable
      - `labels` object[]
        - `color` string
        - `name` string
        - `publicId` string
        - `company` object
          - `publicId` string
      - `custom` object
    - `pageLinks` object[]
      - `publicId` string
      - `agent` object, nullable
        - `publicId` string
      - `asset` object, nullable
        - `publicId` string
      - `menuItem` object, nullable
        - `publicId` string
      - `page` object
        - `publicId` string
      - `audience` object, nullable
        - `publicId` string
        - `name` string
        - `description` string, nullable
        - `custom` object
        - `default` boolean
        - `type` 'alarm' | 'page' | 'service', nullable
      - `group` object, nullable
        - `publicId` string
        - `agent` object, nullable
          - `publicId` string
        - `asset` object, nullable
          - `publicId` string
        - `menuItem` object, nullable
          - `publicId` string
        - `name` string
      - `order` integer
      - `custom` object
    - `order` integer
    - `pinned` boolean
    - `audience` object, nullable
      - `publicId` string
      - `name` string
      - `description` string, nullable
      - `custom` object
      - `default` boolean
      - `type` 'alarm' | 'page' | 'service', nullable
    - `custom` object

## Other responses

- `4XX` — 4XX error response

---

[API](https://skmtc.net/ixon/apis/ixon-api.md) · [All operations](https://skmtc.net/ixon/apis/ixon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ixon/ixon-api/revisions/7875dc33d41f/schema)