Skip to main content
GET
Subrestaurants list

Authorizations

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)

visible
enum<integer>
default:1

Filter for visible locations only (0 = all, 1 = only non-hidden locations)

Available options:
0,
1

Response

Subrestaurants list response

success
boolean
required

Operation result: true if successful, false if failed

subrestaurants
object[]

List of subrestaurants (present if success = true)

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