> ## 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.

# Elenco locali

> Restituisce l'elenco dei locali (subrestaurant) associati all'account ristorante.



## OpenAPI

````yaml openapi-it.json GET /account/subrestaurants
openapi: 3.1.0
info:
  title: xMenu API
  description: API Pubblica xMenu - Endpoint REST e notifiche webhook
  version: 1.0.0
servers:
  - url: https://app.xmenu.it/api
    description: xMenu API Production
security: []
paths:
  /account/subrestaurants:
    get:
      tags:
        - Info account
      summary: Elenco locali
      description: >-
        Restituisce l'elenco dei locali (subrestaurant) associati all'account
        ristorante.
      operationId: getSubrestaurants
      parameters:
        - name: restuid
          in: query
          required: false
          schema:
            type: string
          description: >-
            Identificatore univoco ristorante (non necessario con autenticazione
            via `X-Client-Id`)
        - name: visible
          in: query
          required: false
          schema:
            type: integer
            enum:
              - 0
              - 1
            default: 1
          description: >-
            Filtro per soli locali visibili (0 = tutti, 1 = solo locali non
            nascosti)
      responses:
        '200':
          description: Risposta con elenco locali
          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: >-
            Risultato dell'operazione: `true` se ha avuto successo, `false` se è
            fallita
        subrestaurants:
          type: array
          items:
            $ref: '#/components/schemas/Subrestaurant'
          description: Elenco locali (presente se success = true)
        error:
          type: string
          description: >-
            Codice errore se l'operazione è fallita.


            Vedi [Codici errore](/docs/it/overview/error-codes) per i codici
            errore generali che possono verificarsi.
        message:
          type: string
          description: Descrizione leggibile dell'errore se l'operazione è fallita
    Subrestaurant:
      type: object
      description: Informazioni locale (subrestaurant)
      properties:
        uid:
          type: string
          description: Identificatore univoco locale
        name:
          type: string
          description: Nome locale
        at:
          type: string
          description: C/o (presso)
        code:
          type: string
          description: Codice locale
        address:
          type: string
          description: Indirizzo (via/viale e numero civico)
        city:
          type: string
          description: Città
        province:
          type: string
          description: Sigla provincia
        zip:
          type: string
          description: CAP
        country:
          type: string
          description: Codice paese
        phone:
          type: string
          description: Telefono
        email:
          type: string
          description: Email
  responses:
    Unauthorized:
      description: Autenticazione fallita.
      content:
        application/json:
          schema:
            oneOf:
              - type: object
                description: >-
                  Formato errore standard (quando si usa autenticazione API Key
                  o Client ID/Secret)
                required:
                  - success
                  - error
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Sempre false per gli errori
                  error:
                    type: string
                    enum:
                      - RESTAURANT_NOT_FOUND
                      - INVALID_KEY
                      - INVALID_AUTH
                    description: Codice errore
                  message:
                    type: string
                    description: Descrizione errore leggibile
              - type: object
                description: >-
                  Formato errore OAuth (quando si usa l'autenticazione Bearer
                  token)
                required:
                  - error
                properties:
                  error:
                    type: string
                    enum:
                      - invalid_token
                      - invalid_request
                    description: Codice errore OAuth (RFC 6749)
                  error_description:
                    type: string
                    description: Descrizione errore leggibile
          examples:
            standard:
              summary: Formato errore standard (API Key / Client ID+Secret)
              value:
                success: false
                error: INVALID_KEY
                message: La chiave API fornita non è valida
            oauth:
              summary: Formato errore OAuth (Bearer token)
              value:
                error: invalid_token
                error_description: Access token non valido o scaduto
    Forbidden:
      description: Autorizzazione fallita - permessi insufficienti o accesso negato.
      content:
        application/json:
          schema:
            oneOf:
              - type: object
                description: >-
                  Formato errore standard (quando si usa autenticazione API Key
                  o Client ID/Secret)
                required:
                  - success
                  - error
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Sempre false per gli errori
                  error:
                    type: string
                    enum:
                      - API_DISABLED
                      - INSUFFICIENT_SCOPE
                      - UNAUTHORIZED
                    description: Codice errore
                  message:
                    type: string
                    description: Descrizione errore leggibile
              - type: object
                description: >-
                  Formato errore OAuth (quando si usa l'autenticazione Bearer
                  token)
                required:
                  - error
                properties:
                  error:
                    type: string
                    enum:
                      - insufficient_scope
                      - invalid_request
                    description: Codice errore OAuth (RFC 6749)
                  error_description:
                    type: string
                    description: Descrizione errore leggibile
          examples:
            standard:
              summary: Formato errore standard (API Key / Client ID+Secret)
              value:
                success: false
                error: API_DISABLED
                message: L'accesso API non è abilitato per il ristorante
            oauth:
              summary: Formato errore OAuth (Bearer token)
              value:
                error: insufficient_scope
                error_description: 'Permessi mancanti richiesti: write:orders'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Chiave API del ristorante. Può essere ottenuta da Strumenti > Accesso
        API nella dashboard xMenu.
    clientId:
      type: apiKey
      in: header
      name: X-Client-Id
      description: >-
        Client ID per l'autenticazione API Client (deve essere usato insieme al
        Client Secret)
    clientSecret:
      type: apiKey
      in: header
      name: X-Client-Secret
      description: >-
        Client Secret per l'autenticazione API Client (deve essere usato insieme
        al Client ID)
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://app.xmenu.it/oauth/token
          scopes: {}
      description: >-
        Autenticazione OAuth 2.0 utilizzando il flusso client credentials. Il
        token di accesso deve essere incluso nell'header Authorization come
        Bearer token.

````