Skip to main content
GET
Get category

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