Facilio Indoor Floor Plans API

openapi: 3.2.0
info:
  title: Facilio REST Indoor Floor Plans API
  version: 5.0.0
  description: 'The Facilio REST API gives you programmatic access to Facilio''s Connected CMMS — the unified platform for managing property operations at portfolio scale. Build integrations that connect Facilio with your ERP, accounting systems, BMS, IoT platforms, and other business tools. Automate work order creation from external triggers, synchronize asset data across systems, push tenant and vendor records from your CRM, or pull maintenance data into your reporting dashboards. **What you can do with this API:**

    - **Work Orders & Service Requests** — Create, assign, track, and close maintenance tasks programmatically

    - **Assets** — Manage your equipment registry, track asset lifecycle, and sync with external asset management systems

    - **Portfolio (Sites, Buildings, Floors, Spaces)** — Maintain your facility hierarchy and space data

    - **People (Tenants, Vendors, Clients)** — Synchronize contacts and stakeholder records

    - **Inventory (Item Types, Tool Types, Items & Tools, Services, Storerooms)** — Master data, per-storeroom item/tool balances (read), per-bin quantities by item or tool record, quantity adjustments, and warehouse locations

    - **Procurement (Quotes, Purchase Requests, Purchase Orders, Receivable receiving, Invoices)** — Procurement with line items; receive against a PO via receivable APIs

    - **Credit Notes (Vendor Credits, Client Credits)** — Manage credit notes for refunds and transaction adjustments with line items

    - **Inventory Requests** — Track material requisitions from work orders to storerooms

    - **Custom Modules** — Manage your organization''s custom modules — record types you define for the data and workflows that are specific to your business

    - **Schema Discovery** — List all accessible modules and inspect field schemas (name, type, required, readOnly, lookup target) via `GET /modules` and `GET /{moduleName}/metadata`

    - **Attachments & Comments** — Attach documents, photos, and notes to work orders and service requests

    - **Picklists** — Discover available values for status, priority, category, and other configurable fields


    The API follows REST conventions with JSON request/response bodies, standard HTTP methods (GET, POST, PATCH, DELETE), and consistent error handling across all endpoints. ## Base URL


    ```

    https://{region}.facilioapis.com/{app_name}/api/v5

    ```


    | Variable | Description | Values |

    |----------|-------------|--------|

    | `region` | Your deployment region | `us`, `au`, `ae`, `uk`, `us-azure`, `sa` |

    | `app_name` | `maintenance` for API Key auth, `developer` for OAuth2 auth | `maintenance`, `developer` |


    ## Authentication


    All API requests must be authenticated using one of the following methods:


    ### API Key (Personal Access Token)

    Generate an API key from your Facilio account settings and pass it in the `x-api-key` header. The key inherits the permissions of the user who created it. ```

    x-api-key: your-api-key-here

    ```


    ### OAuth2

    For developer app integrations. Supports **authorization_code** and **password** grant types. | Endpoint | URL |

    |----------|-----|

    | Authorize | `https://{region}.facilioapis.com/identity/oauth2/authorize` |

    | Token | `https://{region}.facilioapis.com/identity/oauth2/token` |

    | Refresh | `https://{region}.facilioapis.com/identity/oauth2/token` (with `grant_type=refresh_token`) |

    | Revoke | `https://{region}.facilioapis.com/identity/oauth2/revoke` |


    Pass the access token as:

    ```

    Authorization: Bearer oauth2

    ```


    ---


    ## List Operations


    All list endpoints (`GET /{module}`) support these query parameters:


    | Parameter | Type | Default | Description |

    |-----------|------|---------|-------------|

    | `page` | integer | 1 | Page number (1-based) |

    | `pageSize` | integer | 50 | Number of records per page. Maximum is 200. |

    | `select` | string | — | Comma-separated field names to include in the response. If omitted, module default fields are returned. |

    | `expand` | string | — | Comma-separated lookup field names to expand with full details (max 5).'
  contact:
    name: Facilio Support
    url: https://facilio.com
  license:
    name: Proprietary
servers:
- url: https://{region}.facilioapis.com/{app_name}/api/v5
  variables:
    region:
      description: Regional deployment
      default: us
      enum:
      - us
      - au
      - ae
      - uk
      - us-azure
      - sa
    app_name:
      description: '''maintenance'' for API Key, ''developer'' for OAuth2'
      default: maintenance
      enum:
      - maintenance
      - developer
security:
- apiKey: []
- oauth2: []
tags:
- name: Indoor Floor Plans
  description: Indoor floor plans are the visual maps of a floor, mapping desks, rooms, and other spaces to on-screen coordinates for the floor plan viewer and booking UI.
paths:
  /indoorfloorplan:
    get:
      tags:
      - Indoor Floor Plans
      summary: List indoor floor plans
      operationId: listIndoorFloorPlans
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/count'
      responses:
        '200':
          description: List of indoor floor plans
          content:
            application/json:
              example:
                success: true
                data:
                - id: 500
                  name: Floor 3 Plan
                  site:
                    id: 10
                  building:
                    id: 20
                  floor:
                    id: 30
                  floorPlanType: Workstation
                pagination:
                  page: 1
                  pageSize: 50
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      tags:
      - Indoor Floor Plans
      summary: Create an indoor floor plan
      description: Creates a new indoor floor plan. Requires `name`, `site`, `building`, `floor`, `geometry`, and `properties`.
      operationId: createIndoorFloorPlan
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  $ref: '#/components/schemas/IndoorFloorPlan'
            example:
              data:
                name: Floor 4 Plan
                site: 10
                building: 20
                floor: 31
                floorPlanType: Workstation
                geometry: '{}'
                properties: '{}'
      responses:
        '201':
          description: Indoor floor plan created
          content:
            application/json:
              example:
                success: true
                data:
                  id: 501
                  name: Floor 4 Plan
                message: Record created
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /indoorfloorplan/{id}:
    get:
      tags:
      - Indoor Floor Plans
      summary: Get an indoor floor plan
      operationId: getIndoorFloorPlan
      parameters:
      - $ref: '#/components/parameters/recordId'
      responses:
        '200':
          description: Indoor floor plan details
          content:
            application/json:
              example:
                success: true
                data:
                  id: 500
                  name: Floor 3 Plan
                  floorPlanType: Workstation
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      tags:
      - Indoor Floor Plans
      summary: Update an indoor floor plan
      operationId: updateIndoorFloorPlan
      parameters:
      - $ref: '#/components/parameters/recordId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  $ref: '#/components/schemas/IndoorFloorPlan'
            example:
              data:
                isActive: false
      responses:
        '200':
          description: Indoor floor plan updated
          content:
            application/json:
              example:
                success: true
                message: Record updated
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      tags:
      - Indoor Floor Plans
      summary: Delete an indoor floor plan
      operationId: deleteIndoorFloorPlan
      parameters:
      - $ref: '#/components/parameters/recordId'
      responses:
        '200':
          description: Indoor floor plan deleted
          content:
            application/json:
              example:
                success: true
                message: Record deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /indoorfloorplan/metadata:
    get:
      tags:
      - Indoor Floor Plans
      summary: Get indoor floor plan field schema
      description: Returns the field schema for the indoorfloorplan module, including all declared system fields and any org-specific custom fields with their data type, required/readOnly flags, and lookup targets.
      operationId: getIndoorFloorPlanMetadata
      parameters:
      - $ref: '#/components/parameters/includeAllowedValues'
      responses:
        '200':
          description: Field schema retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleMetaResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /indoorfloorplan/{id}/viewdata:
    get:
      tags:
      - Indoor Floor Plans
      summary: Get floor plan viewer data
      description: Returns the markers, zones, and mapped module objects for the floor plan viewer or booking UI. `viewMode` selects `ASSIGNMENT` (default) or `BOOKING`; `objectIds` is a comma-separated list of marker/zone ids to filter to.
      operationId: getIndoorFloorPlanViewData
      parameters:
      - $ref: '#/components/parameters/recordId'
      - in: query
        name: viewMode
        schema:
          type: string
          enum:
          - ASSIGNMENT
          - BOOKING
      - in: query
        name: objectIds
        schema:
          type: string
        description: Comma-separated marker/zone ids
      - in: query
        name: startTime
        schema:
          type: integer
          format: int64
        description: Epoch millis — required when viewMode=BOOKING
      - in: query
        name: endTime
        schema:
          type: integer
          format: int64
        description: Epoch millis — required when viewMode=BOOKING
      responses:
        '200':
          description: Floor plan viewer data
          content:
            application/json:
              example:
                success: true
                data:
                  marker: {}
                  spaceZone: {}
                  indoorFloorPlan:
                    id: 500
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /indoorfloorplan/{id}/propertiesdata:
    get:
      tags:
      - Indoor Floor Plans
      summary: Get floor plan object properties
      description: Returns the properties panel data for a specific marker/zone (`objectId`) placed on the floor plan.
      operationId: getIndoorFloorPlanPropertiesData
      parameters:
      - $ref: '#/components/parameters/recordId'
      - in: query
        name: objectId
        required: true
        schema:
          type: integer
          format: int64
      - in: query
        name: viewMode
        schema:
          type: string
          enum:
          - ASSIGNMENT
          - BOOKING
      - in: query
        name: startTime
        schema:
          type: integer
          format: int64
      - in: query
        name: endTime
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Floor plan object properties
          content:
            application/json:
              example:
                success: true
                data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /indoorfloorplan/getFacilityDetails:
    get:
      tags:
      - Indoor Floor Plans
      summary: Get facility/booking details for a set of spaces
      description: Module-level (no record id) — returns facility and facility-booking data for the given `spaceIds` over a time range. Used by the floor plan booking viewer to show which mapped spaces are already booked.
      operationId: getIndoorFloorPlanFacilityDetails
      parameters:
      - in: query
        name: spaceIds
        schema:
          type: string
        description: Comma-separated space ids
      - in: query
        name: startTime
        schema:
          type: integer
          format: int64
        description: Epoch millis
      - in: query
        name: endTime
        schema:
          type: integer
          format: int64
        description: Epoch millis
      responses:
        '200':
          description: Facility/booking details
          content:
            application/json:
              example:
                success: true
                data:
                  facility: {}
                  facilityBooking: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
  /indoorfloorplan/getFloorplanDetailsByType:
    get:
      tags:
      - Indoor Floor Plans
      summary: List floor plans for a floor
      description: Module-level (no record id) — returns the indoor floor plans mapped to the given `floorId`.
      operationId: getIndoorFloorPlanDetailsByType
      parameters:
      - in: query
        name: floorId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Floor plans for the floor
          content:
            application/json:
              example:
                success: true
                data:
                  indoorFloorPlans: []
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    FacilioField:
      type: object
      description: Schema descriptor for a single field within a module.
      properties:
        name:
          type: string
          description: Field name used in API requests and responses (e.g. `subject`, `po_reference_workorder`)
        displayName:
          type: string
          description: Human-readable field label
        dataType:
          type: string
          description: 'Field data type. Common values:

            `STRING`, `NUMBER`, `DECIMAL`, `BOOLEAN`,

            `DATE`, `DATE_TIME`,

            `BIG_STRING` (large text, excluded from list responses),

            `LOOKUP` (reference to another record — see `lookupModuleName`),

            `MULTI_LOOKUP` (multi-reference — see `lookupModuleName`),

            `ENUM`, `SYSTEM_ENUM`, `STRING_SYSTEM_ENUM` (picklist types)

            '
          example: STRING
        required:
          type: boolean
          description: '`true` if this field must be provided on record creation'
        readOnly:
          type: boolean
          description: '`true` if this field cannot be set or modified via the API (e.g. auto-generated system fields)'
        isCustom:
          type: boolean
          description: '`true` for fields added by your organization; `false` for standard built-in fields'
        sortable:
          type: boolean
          description: '`true` if this field can be used as a `sortBy` value on the list API'
        lookupModuleName:
          type: string
          description: Present only on `LOOKUP` and `MULTI_LOOKUP` fields. The name of the target module (e.g. `site`, `users`, `ticketstatus`).
        max_length:
          type: integer
          description: 'Maximum number of characters accepted by the V5 write API for text-style fields.

            Present only when the field''s `dataType` is one of:

            `STRING` (255), `LARGE_TEXT` (2000), `BIG_STRING` (32000).

            Omitted for all other data types.

            '
          example: 255
        allowed_values:
          type: array
          description: 'List of acceptable write values for picklist-capable fields. Present **only when the request includes `?includeAllowedValues=true`** AND the field is one of:

            `ENUM`, `SYSTEM_ENUM`, `MULTI_ENUM`, `STRING_SYSTEM_ENUM`, or a `LOOKUP` targeting a system picklist module (e.g. `ticketstatus`, `ticketpriority`, `ticketcategory`, `tickettype`).

            Each entry uses `{label, value}`; the `value` is the canonical form accepted by create/update payloads.

            '
          items:
            type: object
            properties:
              label:
                type: string
                description: Display label as shown in the UI
              value:
                type: string
                description: Canonical value accepted by create/update for this field and filtering
    IndoorFloorPlan:
      type: object
      description: The visual map of a floor, mapping desks, rooms, and other spaces to on-screen coordinates.
      required:
      - name
      - site
      - building
      - floor
      - geometry
      - properties
      properties:
        id:
          type: integer
          readOnly: true
          description: Unique record ID
        name:
          type: string
          description: Floor plan name (required on create, sortable)
        description:
          type: string
          description: Description
        site:
          type: integer
          description: Site ID (required on create)
        building:
          type: integer
          description: Building ID (required on create)
        floor:
          type: integer
          description: Floor ID (required on create)
        file:
          type: string
          description: Floor plan image/AutoCAD file — see the file field API
        floorPlanType:
          type: string
          description: Floor plan type, e.g. Workstation, Lockers, Parking
        filesource:
          type: string
          description: Source file type, e.g. Image, AUTO CAD
        width:
          type: number
          description: Canvas width
        height:
          type: number
          description: Canvas height
        iconSize:
          type: number
          description: Marker icon size
        fontSize:
          type: number
          description: Label font size
        minZoom:
          type: number
          description: Minimum zoom level
        maxZoom:
          type: number
          description: Maximum zoom level
        geometry:
          type: string
          description: Serialized floor plan geometry (required on create)
        properties:
          type: string
          description: Serialized floor plan properties (required on create)
        customizationJSON:
          type: string
          description: Serialized viewer customization JSON
        customizationBookingJSON:
          type: string
          description: Serialized booking-view customization JSON
        startTime:
          type: string
          format: date-time
          description: Effective start time
        endTime:
          type: string
          format: date-time
          description: Effective end time
        isActive:
          type: boolean
          description: Whether the floor plan is active
        sysCreatedTime:
          type: string
          format: date-time
          readOnly: true
          description: Creation timestamp (sortable)
        sysModifiedTime:
          type: string
          format: date-time
          readOnly: true
          description: Last modified (sortable)
    ModuleMetaResponse:
      type: object
      description: Response body for GET /{moduleName}/metadata.
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            module:
              $ref: '#/components/schemas/FacilioModule'
            fields:
              type: array
              description: 'Ordered list of fields for the module.

                Standard Facilio modules return built-in fields first, followed by any fields your organization added.

                Custom modules return all fields.

                '
              items:
                $ref: '#/components/schemas/FacilioField'
    Error:
      type: object
      description: Error response
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code
            message:
              type: string
              description: Human-readable error message
    FacilioModule:
      type: object
      description: A single entry in the module catalogue returned by GET /modules.
      properties:
        name:
          type: string
          description: Module name used in all API paths (e.g. `workorder`, `custom_employees`)
        displayName:
          type: string
          description: Human-readable module label (e.g. `Work Orders`, `Employees`)
        description:
          type: string
          description: Module description as configured in Facilio Setup. Omitted when blank.
        isCustom:
          type: boolean
          description: '`true` for modules created by your organization; `false` for standard Facilio modules'
  parameters:
    recordId:
      name: id
      in: path
      required: true
      description: Record ID
      schema:
        type: integer
        format: int64
    includeAllowedValues:
      name: includeAllowedValues
      in: query
      description: 'When `true`, the metadata response adds `allowed_values` ([{label, value}]) on every picklist-capable field — `ENUM`, `SYSTEM_ENUM`, `MULTI_ENUM`, `STRING_SYSTEM_ENUM`, and `LOOKUP` fields targeting system picklist modules (status, priority, category, type, ...).

        Default `false` keeps the original metadata payload (no enrichment, no extra DB calls).

        Use this to discover acceptable write values without round-tripping `GET /picklist/{moduleName}/{fieldName}` for every picklist field.

        '
      schema:
        type: boolean
        default: false
    search:
      name: search
      in: query
      description: Free-text search on the primary field (subject, name, etc.)
      schema:
        type: string
    select:
      name: select
      in: query
      description: Comma-separated field names to include in the response
      schema:
        type: string
    page:
      name: page
      in: query
      description: Page number (1-based)
      schema:
        type: integer
        default: 1
    count:
      name: count
      in: query
      description: Include total record count in response
      schema:
        type: boolean
        default: false
    pageSize:
      name: pageSize
      in: query
      description: Records per page (max 200)
      schema:
        type: integer
        default: 50
        maximum: 200
  responses:
    BadRequest:
      description: Validation error — missing required fields, invalid field values, or malformed request body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error:
              code: VALIDATION_ERROR
              message: 'Required field(s) missing: name'
    Unauthorized:
      description: Missing or invalid authentication credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error:
              code: UNAUTHORIZED
              message: Missing or invalid authentication credentials
    NotFound:
      description: Record or module not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error:
              code: RECORD_NOT_FOUND
              message: Record with the given ID was not found
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Personal access token
    oauth2:
      type: oauth2
      description: Supports authorization_code and password grant types
      flows:
        authorizationCode:
          authorizationUrl: https://us.facilioapis.com/identity/oauth2/authorize
          tokenUrl: https://us.facilioapis.com/identity/oauth2/token
          refreshUrl: https://us.facilioapis.com/identity/oauth2/token
          scopes: {}
        password:
          tokenUrl: https://us.facilioapis.com/identity/oauth2/token
          refreshUrl: https://us.facilioapis.com/identity/oauth2/token
          scopes: {}
x-provenance:
  method: harvested
  publisher: Facilio
  source: https://static.facilio.com/developers/api/v5/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)