> ## Documentation Index > Fetch the complete documentation index at: https://api-doc.xmenu.it/llms.txt > Use this file to discover all available pages before exploring further. # Subrestaurants list > Returns the list of subrestaurants (locations) associated with the restaurant account. ## OpenAPI ````yaml openapi-en.json GET /account/subrestaurants openapi: 3.1.0 info: title: xMenu API description: xMenu Public API - REST endpoints and webhook notifications version: 1.0.0 servers: - url: https://app.xmenu.it/api description: xMenu API Production security: [] paths: /account/subrestaurants: get: tags: - Account Info summary: Subrestaurants list description: >- Returns the list of subrestaurants (locations) associated with the restaurant account. operationId: getSubrestaurants parameters: - name: restuid in: query required: false schema: type: string description: >- Unique restaurant identifier (not required with `X-Client-Id` authentication) - name: visible in: query required: false schema: type: integer enum: - 0 - 1 default: 1 description: >- Filter for visible locations only (0 = all, 1 = only non-hidden locations) responses: '200': description: Subrestaurants list response content: application/json: schema: $ref: '#/components/schemas/SubrestaurantsResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' security: - apiKey: [] - clientId: [] clientSecret: [] - oauth2: [] components: schemas: SubrestaurantsResponse: type: object required: - success properties: success: type: boolean description: 'Operation result: `true` if successful, `false` if failed' subrestaurants: type: array items: $ref: '#/components/schemas/Subrestaurant' description: List of subrestaurants (present if success = true) error: type: string description: >- Error code if the operation failed. See [Error codes](/docs/en/overview/error-codes) for general error codes that may occur. message: type: string description: Human-readable error description if the operation failed Subrestaurant: type: object description: Subrestaurant (location) information properties: uid: type: string description: Unique subrestaurant identifier name: type: string description: Location name at: type: string description: C/o (care of) code: type: string description: Location code address: type: string description: Address (street/avenue and number) city: type: string description: City province: type: string description: Province code zip: type: string description: ZIP code country: type: string description: Country code phone: type: string description: Phone number email: type: string description: Email address responses: Unauthorized: description: Authentication failed. content: application/json: schema: oneOf: - type: object description: >- Standard error format (when using API Key or Client ID/Secret authentication) required: - success - error properties: success: type: boolean enum: - false description: Always false for errors error: type: string enum: - RESTAURANT_NOT_FOUND - INVALID_KEY - INVALID_AUTH description: Error code message: type: string description: Human-readable error description - type: object description: OAuth error format (when using Bearer token authentication) required: - error properties: error: type: string enum: - invalid_token - invalid_request description: OAuth error code (RFC 6749) error_description: type: string description: Human-readable error description examples: standard: summary: Standard error format (API Key / Client ID+Secret) value: success: false error: INVALID_KEY message: The provided API key is not valid oauth: summary: OAuth error format (Bearer token) value: error: invalid_token error_description: Access token is invalid or expired Forbidden: description: Authorization failed - insufficient permissions or access denied. content: application/json: schema: oneOf: - type: object description: >- Standard error format (when using API Key or Client ID/Secret authentication) required: - success - error properties: success: type: boolean enum: - false description: Always false for errors error: type: string enum: - API_DISABLED - INSUFFICIENT_SCOPE - UNAUTHORIZED description: Error code message: type: string description: Human-readable error description - type: object description: OAuth error format (when using Bearer token authentication) required: - error properties: error: type: string enum: - insufficient_scope - invalid_request description: OAuth error code (RFC 6749) error_description: type: string description: Human-readable error description examples: standard: summary: Standard error format (API Key / Client ID+Secret) value: success: false error: API_DISABLED message: API access is not enabled for the restaurant oauth: summary: OAuth error format (Bearer token) value: error: insufficient_scope error_description: 'Missing required permissions: write:orders' securitySchemes: apiKey: type: apiKey in: header name: X-Api-Key description: >- Restaurant API Key. Can be obtained from Tools > API Access in the xMenu dashboard. clientId: type: apiKey in: header name: X-Client-Id description: >- Client ID for API Client authentication (must be used together with Client Secret) clientSecret: type: apiKey in: header name: X-Client-Secret description: >- Client Secret for API Client authentication (must be used together with Client ID) oauth2: type: oauth2 flows: clientCredentials: tokenUrl: https://app.xmenu.it/oauth/token scopes: {} description: >- OAuth 2.0 authentication using client credentials flow. The access token must be included in the Authorization header as a Bearer token. ````