Property Management

Integration ProviderDevicePinUnitOther
ButterflyMX
igloohome
AppFolio (API)
AppFolio (Reports)Custom Reports

Don't see the integration provider or resource you want? Let us know and we will build it out ASAP!


Device: property_management-device

A device is used to manage access points in a property management system.

{
  "type": {
    "title": "Type",
    "type": "string",
    "enum": [
      "Lock",
      "Keypad",
      "Bridge",
      "Fob",
    ]
  },
  "name": {
    "title": "Name",
    "type": "string"
  },
  "battery_level": {
    "title": "Battery Level",
    "type": "number"
  },
  "paired_at": {
    "title": "Paired At",
    "type": "string",
    "format": "date-time"
  },
  "home_id": {
    "items": {
      "type": "string"
    },
    "title": "Associated Home/Property IDs",
    "type": "array"
  },
  "linked_devices": {
    "items": {
      "properties": {
        "type": {
          "title": "Linked Device Type",
          "type": "string",
          "enum": [
            "Lock",
            "Keypad",
            "Bridge",
            "Fob",
          ]
        },
        "device_id": {
          "title": "Linked Device ID",
          "type": "string"
        }
      },
      "type": "object"
    },
    "title": "Linked Devices",
    "type": "array"
  },
}
{
  "type": "Lock",
  "name": "Front Door Lock",
  "battery_level": 85.5,
  "paired_at": "2000-01-01 00:00:00",
  "home_id": ["home456", "property789"],
  "linked_devices": [
    {
      "type": "Keypad",
      "device_id": "keypad101"
    },
    {
      "type": "Bridge",
      "device_id": "bridge202"
    }
  ]
}

Management Pin: property_management-pin

A management pin manages access control information for a property.

{
  "device_id": {
    "title": "Device ID",
    "type": "string",
    "description": "The unique identifier for the device associated with this PIN."
  },
  "permanent": {
    "title": "Is Permanent",
    "type": "boolean"
  },
  "access_name": {
    "title": "Access Point Name",
    "type": "string"
  },
  "variance": {
    "title": "Variance",
    "type": "number"
  },
  "start_date": {
    "title": "Start Date",
    "type": "string",
    "format": "date-time"
  },
  "end_date": {
    "title": "End Date",
    "type": "string",
    "format": "date-time"
  },
  "pin": {
    "title": "Access Point PIN",
    "type": "string"
  },
  "qr_code": {
    "title": "Access Point QR Code URI",
    "type": "string",
    "format": "uri"
  },
}
{
  "device_id": "12345",
  "permanent": false,
  "access_name": "Main Entrance",
  "variance": 0.5,
  "start_date": "2000-01-01T00:00:00",
  "end_date": "2000-01-02T00:00:00",
  "pin": "1234",
  "qr_code": "https://developers.endgrate.com/qr/dev123"
}

Unit: property_management-unit

Represents a unit at a property within a property management system.

{
  "address": {
    "title": "Address",
    "type": "object",
    "description": "Primary address of the unit",
    "properties": {
      "primary_city": {
        "title": "Primary City",
        "type": "string",
        "description": "The city of the primary address."
      },
      "primary_country": {
        "title": "Primary Country",
        "type": "string",
        "description": "The country of the primary address."
      },
      "primary_postal_code": {
        "title": "Primary Postal Code",
        "type": "string",
        "description": "The postal or ZIP code of the primary address."
      },
      "primary_state": {
        "title": "Primary State",
        "type": "string",
        "description": "The state or region of the primary address."
      },
      "primary_street_1": {
        "title": "Primary Street 1",
        "type": "string",
        "description": "Line 1 of the street for the primary address."
      },
      "primary_street_2": {
        "title": "Primary Street 2",
        "type": "string",
        "description": "Line 2 of the street for the primary address."
      }
    }
  },
  "unit_name": {
    "title": "Unit Name",
    "type": "string",
  },
  "market_rent": {
    "title": "Market Rent",
    "type": "number"
  },
  "marketing_title": {
    "title": "Marketing Title",
    "type": "string"
  },
  "marketing_description": {
    "title": "Marketing Description",
    "type": "string"
  },
  "sqft": {
    "title": "Square Footage",
    "type": "number"
  },
  "bedrooms": {
    "title": "Bedrooms",
    "type": "number"
  },
  "bathrooms": {
    "title": "Bathrooms",
    "type": "number"
  },
  "unit_tags": {
    "title": "Unit Tags",
    "type": "array",
    "items": {
      "type": "string",
      "title": "Tags"
    }
  },
  "unit_type": {
    "title": "Unit Type",
    "type": "string"
  },
  "description": {
    "title": "Description",
    "type": "string"
  },
  "application_fee": {
    "title": "Application Fee",
    "type": "number"
  },
  "unit_amenities": {
    "title": "Unit Amenities",
    "type": "array",
    "items": {
      "type": "string",
      "title": "Amenities"
    }
  },
  "unit_appliances": {
    "title": "Unit Appliances",
    "type": "array",
    "items": {
      "type": "string",
      "title": "Appliances"
    }
  },
  "unit_utilities": {
    "title": "Unit Utilities",
    "type": "array",
    "items": {
      "type": "string",
      "title": "Utilities"
    }
  },
}
{
   "unit_tags":[
      "1st Floor",
      "Remodeled Kitchen",
      "White Cabinets"
   ],
   "unit_amenities":[
      "Laundry On-Site"
   ],
   "unit_utilities":[
      "Water",
      "Trash",
      "Sewer"
   ],
   "unit_appliances":[
      "Stove/Oven",
      "Rangehood"
   ],
   "address":{
      "primary_city":"1232123",
      "primary_country":"None",
      "primary_postal_code":"91791",
      "primary_state":"CA",
      "primary_street_1":"747 N. Azusa Ave - 7",
      "primary_street_2":"None"
   },
   "unit_name":"1",
   "market_rent":1234.0,
   "marketing_title":"Demonstration purposes only",
   "marketing_description":"",
   "sqft":12345.0,
   "bedrooms":1.0,
   "bathrooms":1.0,
   "unit_type":"1+1",
   "description":"",
   "application_fee":10.0
}