Get meta menu items

GET/menuMeta/

API version

v1

Request method

GET

Operation ID

getNavigationMeta

---

Get the meta for the menu of the customer login

Request

Responses

Format

application/json

Description

The menu result

Schema documentation

• errorsarray of object

  required
  • Array[
    • *object
      • accountstring

        required
      • namestring

        required
      • usagePercentnumber
      • hexCodestring
    ]
• warningsarray of object

  required
  • Array[
    • *object
      • accountstring

        required
      • namestring

        required
      • usagePercentnumber
      • hexCodestring
    ]

Example

Content-Type: application/json

{
  "errors": [
    {
      "account": "string",
      "name": "string",
      "usagePercent": 123,
      "hexCode": "string"
    }
  ],
  "warnings": [
    {
      "account": "string",
      "name": "string",
      "usagePercent": 123,
      "hexCode": "string"
    }
  ]
}

JSON Schema

{
  "type": "object",
  "required": [
    "errors",
    "warnings"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "account",
          "name"
        ],
        "properties": {
          "account": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "usagePercent": {
            "type": "number"
          },
          "hexCode": {
            "type": "string"
          }
        }
      }
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "account",
          "name"
        ],
        "properties": {
          "account": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "usagePercent": {
            "type": "number"
          },
          "hexCode": {
            "type": "string"
          }
        }
      }
    }
  }
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/menuMeta?skipCache=true