Property Management

Below is a reference to the Endgrate types supported for property management integrations, and their corresponding default schemas.

property_management-device

Schema:

{
  "type": {
    "title": "Access Point Type",
    "type": "string",
    "enum": [
      "Lock",
      "Keypad",
      "Bridge",
      "Fob"
    ]
  },
  "id": {
    "title": "Device ID",
    "type": "string"
  },
  "name": {
    "title": "Access Point 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"
  }
}

Example Object:

{
  "type": "Lock",
  "id": "A1B2C3D4",
  "name": "Front Door Lock",
  "battery_level": 100.0,
  "paired_at": "2023-11-15 08:30:00",
  "home_id": [
    "2vr7QysFyAdfrtMhk"
  ],
  "linked_devices": [
    {
      "type": "Lock",
      "device_id": "IGK313fd4899"
    }
  ]
}

property_management-pin

Schema:

{
  "id": {
    "title": "Device ID",
    "type": "string"
  },
  "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"
  }
}

Example Object:

{
  "id": "6657e2821d1b1e8fce6136b9",
  "permanent": false,
  "access_name": "Main Entrance",
  "variance": 1.0,
  "start_date": "2024-01-01 10:00:00",
  "end_date": "2024-06-01 10:00:00",
  "pin": "406615182",
  "qr_code": "https://example.com/qr/X7Y8Z9"
}