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

# List accessible locations

> Returns the one location bound to a location key, or the currently installed locations owned by an agency key's company. Transferred-out locations are omitted.



## OpenAPI

````yaml /api-reference/openapi.json get /locations
openapi: 3.1.0
info:
  title: Funding Machine Public API
  version: 1.0.0
  description: >-
    Read-only access to stored Funding Machine and CRM data. Version 1 never
    creates, changes, bills, pulls, or underwrites data.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://marketplace-app.myfundingmachine.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Locations
    description: Discover locations accessible to the credential.
  - name: Contacts
    description: Find CRM contacts.
  - name: Credit
    description: Read stored, tenant-scoped credit and underwriting data.
  - name: Funding
    description: Read funding plans and applicant next steps.
  - name: Pipeline
    description: Read CRM deal and Funding Machine pipeline state.
  - name: Dashboard
    description: Read bounded aggregate statistics.
paths:
  /locations:
    get:
      tags:
        - Locations
      summary: List accessible locations
      description: >-
        Returns the one location bound to a location key, or the currently
        installed locations owned by an agency key's company. Transferred-out
        locations are omitted.
      operationId: listLocations
      responses:
        '200':
          description: Accessible CRM locations
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - properties:
                      data:
                        type: object
                        required:
                          - scope
                          - total
                          - locations
                        properties:
                          scope:
                            type: string
                            enum:
                              - location
                              - agency
                          total:
                            type: integer
                          locations:
                            type: array
                            items:
                              $ref: '#/components/schemas/Location'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    SuccessEnvelope:
      type: object
      required:
        - data
        - requestId
      properties:
        data: {}
        requestId:
          type: string
          pattern: ^req_
    Location:
      type: object
      required:
        - locationId
        - locationName
      properties:
        locationId:
          type: string
        locationName:
          type:
            - string
            - 'null'
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - requestId
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - unauthorized
                - forbidden
                - not_found
                - rate_limited
                - internal_error
            message:
              type: string
            requestId:
              type: string
              pattern: ^req_
  responses:
    Unauthorized:
      description: Missing, malformed, unknown, expired, or revoked bearer credential
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: The credential lacks read access or cannot access the requested location
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimited:
      description: Per-credential rate limit exceeded
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          description: Seconds until retry.
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          description: Requests allowed per window.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests remaining in this window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix timestamp in seconds for reset.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: Unexpected server error
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  headers:
    RequestId:
      description: Stable identifier for this request.
      schema:
        type: string
        pattern: ^req_
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Use an existing fmk_ API key from Settings → Integrations or an fmo_
        OAuth access token.

````

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