How to: Retrieve the State of a Property

For information about prerequisites, see Integrate with Facilities.

To retrieve the current state of a Property, call the Get Property State endpoint by providing the propertyId in the path parameter.

The response body is returned in JSON format:

{
  "error": {
    "code": "string",
    "description": "string"
  },
  "request": {
    "uri": "string",
    "body": {}
  },
  "data": {
    "event": {
      "toState": "active:available",
      "reasonCode": "R-104",
      "data": {}
    },
    "id": "property:e5f2064c-1a8c-45d9-b125-05a5416135c9",
    "state": "active:available"
  }
}