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

# List the locations this key can read

> Requires an organization API key with merchant:read. Lists the live locations the key was granted, in the merchant's own order, with the id to address them by, their name and their formatted address, so an integration can choose one. Archived locations are left out. Carries no order figures: an integration that only needs to pick a location should not pay for the totals the partner dashboard computes.



## OpenAPI

````yaml /generated/integration.openapi.json get /locations
openapi: 3.0.3
info:
  title: Crave Server-to-Server Integration API
  version: 1.0.0
  description: >-
    Organization-scoped integration operations. Never expose an organization API
    key to a browser or diner.
servers:
  - url: https://sandbox-api.craveup.com/api/v1
    description: Sandbox
  - url: https://api.craveup.com/api/v1
    description: Production
security: []
paths:
  /locations:
    get:
      summary: List the locations this key can read
      description: >-
        Requires an organization API key with merchant:read. Lists the live
        locations the key was granted, in the merchant's own order, with the id
        to address them by, their name and their formatted address, so an
        integration can choose one. Archived locations are left out. Carries no
        order figures: an integration that only needs to pick a location should
        not pay for the totals the partner dashboard computes.
      operationId: integrationListLocations
      parameters: []
      responses:
        '200':
          description: The key's live locations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationLocationList'
        '401':
          description: >-
            Organization API key missing, invalid, or for a different
            environment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateApiError'
        '403':
          description: Key scope denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateApiError'
        '429':
          description: Baseline API rate limit exceeded before route authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
        '500':
          description: Locations could not be read.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateApiError'
        '503':
          description: >-
            Rate-limit storage unavailable; request denied before the route
            handler.
          headers:
            Retry-After:
              schema:
                type: string
                enum:
                  - '1'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitStoreError'
      security:
        - OrganizationApiKey: []
components:
  schemas:
    IntegrationLocationList:
      type: object
      properties:
        locations:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                pattern: >-
                  ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
              name:
                type: string
              address:
                nullable: true
                type: string
            required:
              - id
              - name
              - address
            additionalProperties: false
      required:
        - locations
      additionalProperties: false
    PrivateApiError:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
        code:
          type: string
        data:
          type: object
          additionalProperties: true
    RateLimitError:
      type: object
      required:
        - status
        - message
      properties:
        status:
          type: integer
          enum:
            - 429
        message:
          type: string
    RateLimitStoreError:
      type: object
      required:
        - status
        - code
        - message
      properties:
        status:
          type: integer
          enum:
            - 503
        code:
          type: string
          enum:
            - RATE_LIMIT_STORE_UNAVAILABLE
        message:
          type: string
  securitySchemes:
    OrganizationApiKey:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.