The Door/Gate Controller object
Attributes
-
door_id
stringrequiredUnique identifier for the Door/Gate Controller. Store this in your system after discovery and use it when calling the unlock endpoint.
-
facility_id
stringrequiredPerformance Hub facility ID.
-
linking_identifier
stringoptionalPartner facility identifier when your integration uses linking identifiers. Learn more
-
name
stringrequiredHuman-readable device name configured in Performance Hub.
-
zone
stringoptionalDoor zone or location, such as
Entrance. -
status
stringrequiredonlineoroffline. -
relay_state
stringoptionalLatest known relay state, such as
lockedorunlocked. -
maintenance_mode
stringrequiredCurrent maintenance mode. One of
off,force-open, orforce-closed. -
hold_time_seconds
integerrequiredDefault unlock hold time configured for the door.
-
last_seen
stringoptionalISO timestamp for the latest device metadata update.
The Door/Gate Controller object
{
"door_id": "00000000000000000000000000000007",
"facility_id": "550e8400-e29b-41d4-a716-446655440000",
"linking_identifier": "branch_downtown",
"name": "Front Door",
"zone": "Entrance",
"status": "online",
"online": true,
"relay_state": "locked",
"maintenance_mode": "off",
"hold_time_seconds": 10,
"last_seen": "2026-05-01T04:30:00.000Z"
}