Skip to main content
GET
/
menu
/
category
Get category
curl --request GET \
  --url https://app.xmenu.it/api/menu/category \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "category": {
    "uid": "<string>",
    "name": "<string>",
    "description": "<string>",
    "image": "<string>",
    "products_count": 123,
    "url": "<string>",
    "hidden": true,
    "position": 123,
    "subrestaurant_uids": [
      "<string>"
    ],
    "ext_id": "<string>",
    "options": [
      {
        "uid": "<string>",
        "name": "<string>",
        "short_name": "<string>",
        "type": "single",
        "min_selectable": 123,
        "max_selectable": 123,
        "max_quantity": 123,
        "note": "<string>",
        "hidden": true,
        "position": 123,
        "primary": true,
        "first_default": true,
        "show_caption": true,
        "print_caption": true,
        "subrestaurant_uids": [
          "<string>"
        ],
        "ext_id": "<string>",
        "option_values": [
          {
            "uid": "<string>",
            "name": "<string>",
            "short_name": "<string>",
            "price_operator": "+",
            "price_operand": 123,
            "hidden": true,
            "position": 123,
            "checked_default": true,
            "subrestaurant_uids": [
              "<string>"
            ],
            "ext_id": "<string>"
          }
        ]
      }
    ]
  },
  "error": "<string>",
  "message": "<string>"
}

Authorizations

​
X-Api-Key
string
header
required

Restaurant API Key. Can be obtained from Tools > API Access in the xMenu dashboard.

Query Parameters

​
uid
string
required

Unique category identifier

Response

Category response

​
success
boolean
required

Operation result: true if successful, false if failed

​
category
object

Menu category

​
error
string

Error code if the operation failed. Possible values:

  • CATEGORY_NOT_FOUND = Requested category not found

See Error codes for general error codes that may also occur.

​
message
string

Human-readable error description if the operation failed