> ## Documentation Index
> Fetch the complete documentation index at: https://docs.maple.inc/llms.txt
> Use this file to discover all available pages before exploring further.

# List locations

> Lists the locations the authenticated app has been granted access to.



## OpenAPI

````yaml /openapi/developer-api.json get /locations
openapi: 3.1.0
info:
  title: Maple Developer API
  version: 0.0.1
  description: >-
    Public API for POS and platform partners to integrate with Maple: granted
    locations and connections, the order loop (validation, notification,
    accept/deny, status updates), payment-link visibility, menu publishing, and
    HMAC-signed webhooks. Authenticate every request with a Bearer API key
    (`mpk_test_…` / `mpk_live_…`). The credential determines the environment:
    test-mode credentials only see test data, live-mode credentials only see
    live data.
servers:
  - url: https://api.maple.inc/v1
    description: Production
  - url: https://api.staging.maple.inc/v1
    description: Sandbox (development and testing)
security: []
tags:
  - name: General
    description: Service status and credential introspection.
  - name: Locations
    description: The restaurant locations your app has been granted access to.
  - name: Connections
    description: Become (or stop being) a granted location’s order receiver.
  - name: Menu
    description: Publish and read a connected location’s menu.
  - name: Orders
    description: 'The order loop: read orders, submit validation results, and decide orders.'
  - name: Webhooks
    description: Event-type catalog, subscriptions, the event ledger, and replay.
paths:
  /locations:
    get:
      tags:
        - Locations
      summary: List locations
      description: Lists the locations the authenticated app has been granted access to.
      operationId: developer-api.listLocations
      parameters: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - list
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        object:
                          type: string
                          enum:
                            - location
                        id:
                          type: string
                        name:
                          anyOf:
                            - type: string
                            - type: 'null'
                        status:
                          type: string
                          enum:
                            - active
                            - inactive
                            - paused
                        timezone:
                          anyOf:
                            - type: string
                            - type: 'null'
                        phone:
                          anyOf:
                            - type: string
                            - type: 'null'
                        address:
                          type: object
                          properties:
                            line1:
                              anyOf:
                                - type: string
                                - type: 'null'
                            line2:
                              anyOf:
                                - type: string
                                - type: 'null'
                            city:
                              anyOf:
                                - type: string
                                - type: 'null'
                            region:
                              anyOf:
                                - type: string
                                - type: 'null'
                            postal_code:
                              anyOf:
                                - type: string
                                - type: 'null'
                            country:
                              anyOf:
                                - type: string
                                - type: 'null'
                          required:
                            - line1
                            - line2
                            - city
                            - region
                            - postal_code
                            - country
                          additionalProperties: false
                      required:
                        - object
                        - id
                        - name
                        - status
                        - timezone
                        - phone
                        - address
                      additionalProperties: false
                required:
                  - object
                  - data
                additionalProperties: false
        '401':
          description: DeveloperApiUnauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiUnauthorized'
        '403':
          description: DeveloperApiForbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperApiForbidden'
      security:
        - bearer: []
components:
  schemas:
    DeveloperApiUnauthorized:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiUnauthorized
        message:
          type: string
      required:
        - _tag
        - message
      additionalProperties: false
    DeveloperApiForbidden:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - DeveloperApiForbidden
        code:
          type: string
          enum:
            - insufficient_scope
            - wrong_environment
        message:
          type: string
      required:
        - _tag
        - code
        - message
      additionalProperties: false
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        API key — `mpk_test_…` for the sandbox, `mpk_live_…` for production.
        Issued by Maple during partner onboarding.

````