Restaurant info

Returns main information about the restaurant account.

GET /account/restaurant

Restaurant info

cURL

curl --request GET \
  --url https://app.xmenu.it/api/account/restaurant \
  --header 'X-Api-Key: <api-key>'

200

Example

{
  "success": true,
  "restaurant": {
    "uid": "<string>",
    "name": "<string>",
    "at": "<string>",
    "address": "<string>",
    "city": "<string>",
    "province": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "website": "<string>",
    "logo": "<string>",
    "has_subrestaurants": true
  },
  "error": "<string>",
  "message": "<string>"
}

Authorizations

apiKeyclientId & clientSecretoauth2

X-Api-Key · string · header · required

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

Query Parameters

restuid · string

Unique restaurant identifier (not required with X-Client-Id authentication)

Response

200

application/json

Restaurant information response

success · boolean · required

Operation result: true if successful, false if failed

restaurant · object

Restaurant account information

Show child attributes

error · string

Error code if the operation failed.

See Error codes for general error codes that may occur.

message · string

Human-readable error description if the operation failed