Indicates whether the device can connect a accessory keypad.
String
required
Display name of the device model.
Boolean
Indicates whether the device has a built in accessory keypad.
String
required
Display name that corresponds to the manufacturer-specific terminology for the device.
String
required
deprecated
Deprecated. use device.display_name insteadName of the device.
Boolean
required
Indicates whether the device is online.
Object
ASSA ABLOY Credential Service metadata for the phone.
Show properties
Array of Objects
Endpoints associated with the phone.
Show properties
String
ID of the associated endpoint.
Boolean
Indicated whether the endpoint is active.
Boolean
Indicates whether the credential service has active endpoints associated with the phone.
Object
Salto Space credential service metadata for the phone.
Show properties
Boolean
Indicates whether the credential service has an active associated phone.
Object
Metadata for an Akiles device.
Show properties
String
Gadget ID for an Akiles device.
String
Gadget name for an Akiles device.
String
Product name for an Akiles device.
Object
Metadata for an Aqara device.
Show properties
String
Device name for an Aqara device.
String
Device ID (did) for an Aqara device.
String or null
Firmware version for an Aqara device.
String
Model identifier for an Aqara device.
Number
Model type for an Aqara device.
String
Parent gateway device ID for an Aqara device.
String or null
Position (room) ID for an Aqara device.
String or null
Time zone reported for an Aqara device (e.g. GMT-07:00).
Object
Metadata for an Arlo camera.
Show properties
String
Device ID reported by Arlo.
String
Device name reported by Arlo.
String
Firmware version reported by Arlo.
String
Hardware version reported by Arlo.
String
Model ID reported by Arlo.
Object
Metadata for an ASSA ABLOY Vostio system.
Show properties
String
Encoder name for an ASSA ABLOY Vostio system.
Object
Metadata for an August device.
Show properties
Boolean
Indicates whether an August device has a keypad.
String
House ID for an August device.
String
House name for an August device.
String
Keypad battery level for an August device.
String
Lock ID for an August device.
String
Lock name for an August device.
String
Model for an August device.
Object
Metadata for an Avigilon Alta system.
Show properties
String
Entry name for an Avigilon Alta system.
Number
Total count of entry relays for an Avigilon Alta system.
String
Organization name for an Avigilon Alta system.
Number
Site ID for an Avigilon Alta system.
String
Site name for an Avigilon Alta system.
Number
Zone ID for an Avigilon Alta system.
String
Zone name for an Avigilon Alta system.
Object
Metadata for a Brivo device.
Show properties
Boolean
Indicates whether the Brivo access point has activation (remote unlock) enabled.
String
Device name for a Brivo device.
Object
Metadata for a ControlByWeb device.
Show properties
String
Device ID for a ControlByWeb device.
String
Device name for a ControlByWeb device.
String or null
Relay name for a ControlByWeb device.
Object
Metadata for a dormakaba Oracode Homeowner’s Portal device.
Show properties
Number
Door ID for a dormakaba Oracode Homeowner’s Portal device.
String
Name of the door for a dormakaba Oracode Homeowner’s Portal device.
String
IANA time zone for a dormakaba Oracode Homeowner’s Portal device.
Array of Objects
User levels for a dormakaba Oracode Homeowner’s Portal device.
Show properties
Number
The user level.
String
The user level check in time.
String
The user level check out time.
String
The user level name.
String
The user level type.
Object
Metadata for a dormakaba Oracode device.
Show properties
String
Device ID for a dormakaba Oracode device.
Number
Door ID for a dormakaba Oracode device.
Boolean
Indicates whether a door is wireless for a dormakaba Oracode device.
String
Door name for a dormakaba Oracode device.
String
IANA time zone for a dormakaba Oracode device.
Array of Objects
Predefined time slots for a dormakaba Oracode device.
Show properties
String
Check in time for a time slot for a dormakaba Oracode device.
String
Checkout time for a time slot for a dormakaba Oracode device.
String (UUID)
ID of a user level for a dormakaba Oracode device.
Number
Prefix for a user level for a dormakaba Oracode device.
Boolean
Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot.
Boolean
Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode.
Boolean
Indicates whether a time slot for a dormakaba Oracode device is a master time slot.
Boolean
Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot.
String
Name of a time slot for a dormakaba Oracode device.
Number
Prefix for a time slot for a dormakaba Oracode device.
String
Site name for a dormakaba Oracode device.
Object
Metadata for an ecobee device.
Show properties
String
Device name for an ecobee device.
String
Device ID for an ecobee device.
Object
Metadata for a Eufy device.
Show properties
String
The device id.
String
The device name.
String
The model.
Object
Metadata for a 4SUITES device.
Show properties
Number
Device ID for a 4SUITES device.
String
Device name for a 4SUITES device.
Number
Reclose delay, in seconds, for a 4SUITES device.
Object
Metadata for a Genie device.
Show properties
String
Lock name for a Genie device.
String
Door name for a Genie device.
Object
Metadata for a Honeywell Resideo device.
Show properties
String
Device name for a Honeywell Resideo device.
String
Device ID for a Honeywell Resideo device.
Object
Metadata for an igloo device.
Show properties
String
Bridge ID for an igloo device.
String
Device ID for an igloo device.
String
Model for an igloo device.
Object
Metadata for an igloohome device.
Show properties
String
Bridge ID for an igloohome device.
String
Bridge name for an igloohome device.
String
Device ID for an igloohome device.
String
Device name for an igloohome device.
Boolean
Indicates whether a keypad is linked to a bridge for an igloohome device.
String
Keypad ID for an igloohome device.
Object
Metadata for a KeyNest device.
Show properties
String or null
Address for a KeyNest device.
Number
Current or last store ID for a KeyNest device.
String or null
Current status for a KeyNest device.
String or null
Current user company for a KeyNest device.
String or null
Current user email for a KeyNest device.
String or null
Current user name for a KeyNest device.
String or null
Current user phone number for a KeyNest device.
Number
Default office ID for a KeyNest device.
String
Device name for a KeyNest device.
Number
Fob ID for a KeyNest device.
String or null
Handover method for a KeyNest device.
Boolean
Whether the KeyNest device has a photo.
Boolean
Whether the key is in a locker that does not support the access codes API.
String
Key ID for a KeyNest device.
String or null
Key notes for a KeyNest device.
String or null
KeyNest app user for a KeyNest device.
String
Last movement timestamp for a KeyNest device.
String or null
Property ID for a KeyNest device.
String or null
Property postcode for a KeyNest device.
String
Status type for a KeyNest device.
String
Subscription plan for a KeyNest device.
Object
Metadata for a Kisi device.
Show properties
String or null
Description for a Kisi device.
Number
Lock ID for a Kisi device.
String
Lock name for a Kisi device.
String or null
Place name for a Kisi device.
Object
Metadata for a Korelock device.
Show properties
String
Device ID for a Korelock device.
String
Device name for a Korelock device.
String
Firmware version for a Korelock device.
String or null
Location ID for a Korelock device. Required for timebound access codes.
String
Model code for a Korelock device.
String
Serial number for a Korelock device.
Number
WiFi signal strength (0-1) for a Korelock device.
Object
Metadata for a Kwikset device.
Show properties
String
Device ID for a Kwikset device.
String
Device name for a Kwikset device.
String
Model number for a Kwikset device.
Object
Metadata for a Lockly device.
Show properties
String
Device ID for a Lockly device.
String
Device name for a Lockly device.
String
Model for a Lockly device.
Object
Metadata for a Minut device.
Show properties
String
Device ID for a Minut device.
String
Device name for a Minut device.
Object
Latest sensor values for a Minut device.
Show properties
Object
Latest accelerometer Z-axis reading for a Minut device.
Show properties
String
Time of latest accelerometer Z-axis reading for a Minut device.
Number
Value of latest accelerometer Z-axis reading for a Minut device.
Object
Latest humidity reading for a Minut device.
Show properties
String
Time of latest humidity reading for a Minut device.
Number
Value of latest humidity reading for a Minut device.
Object
Latest pressure reading for a Minut device.
Show properties
String
Time of latest pressure reading for a Minut device.
Number
Value of latest pressure reading for a Minut device.
Object
Latest sound reading for a Minut device.
Show properties
String
Time of latest sound reading for a Minut device.
Number
Value of latest sound reading for a Minut device.
Object
Latest temperature reading for a Minut device.
Show properties
String
Time of latest temperature reading for a Minut device.
Number
Value of latest temperature reading for a Minut device.
Object
Metadata for a Google Nest device.
Show properties
String
Custom device name for a Google Nest device. The device owner sets this value.
String
Device name for a Google Nest device. Google sets this value.
String
Name of the Google Home room containing the device. The device owner sets this value.
String
Device ID for a Google Nest device.
String
ID of the Google Nest structure containing the device.
String
Name of the Google Nest structure containing the device. The device owner sets this value.
Object
Metadata for a NoiseAware device.
Show properties
String
Device ID for a NoiseAware device.
Enum (String)
Device model for a NoiseAware device.
Enum values
indoor
outdoor
String
Device name for a NoiseAware device.
Number
Noise level, in decibels, for a NoiseAware device.
Number
Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device.
Object
Metadata for a Nuki device.
Show properties
String
Device ID for a Nuki device.
String
Device name for a Nuki device.
Boolean
Indicates whether keypad 2 is paired for a Nuki device.
Boolean
Indicates whether the keypad battery is in a critical state for a Nuki device.
Boolean
Indicates whether the keypad is paired for a Nuki device.
Object
Metadata for an Omnitec device.
Show properties
Boolean
Whether the Omnitec lock has a connected gateway for remote operations.
String
Operator-assigned alias for an Omnitec device.
Number
Lock ID for an Omnitec device.
String
Bluetooth MAC address for an Omnitec device.
String
Lock name for an Omnitec device.
String or null
IANA time zone for the Omnitec device, used to schedule time-bound access codes at the correct local time (accounting for DST).
Number
Static UTC offset of the Omnitec lock in milliseconds. Does not account for DST.
Object
Metadata for a Reolink camera.
Show properties
String
Firmware version reported by the camera.
String
Hardware version reported by the camera.
String
Model reported by the Reolink camera.
Object
Metadata for a Ring device.
Show properties
String
Device ID for a Ring device.
String
Device name for a Ring device.
Object
Metadata for a Salto KS device.
Show properties
String
Battery level for a Salto KS device.
String
Customer reference for a Salto KS device.
Boolean
Indicates whether the site has a Salto KS subscription that supports custom PINs.
String
Lock ID for a Salto KS device.
String
Lock type for a Salto KS device.
String
Locked state for a Salto KS device.
String
Model for a Salto KS device.
String
Site ID for the Salto KS site to which the device belongs.
String
Site name for the Salto KS site to which the device belongs.
Object
Metadata for a Schlage device.
Show properties
String
Device ID for a Schlage device.
String
Device name for a Schlage device.
String
Model for a Schlage device.
Object
Metadata for Seam Bridge.
Show properties
Number
Device number for Seam Bridge.
String
Name for Seam Bridge.
Enum (String)
Unlock method for Seam Bridge.
Enum values
bridge
doorking
Object
Metadata for a Sensi device.
Show properties
String
Device ID for a Sensi device.
String
Device name for a Sensi device.
String
Product type for a Sensi device.
Object
Metadata for a Sensibo device.
Show properties
String
Firmware version of the Sensibo device.
String
MAC address of the Sensibo device.
String
ID of the Sensibo device, which Sensibo calls a pod.
String
Product model of the Sensibo device, such as skyv2 or skyplus.
String
Product name of the Sensibo device, such as Sensibo Sky or Sensibo Air.
String
Name of the room that the Sensibo device is in.
String
Serial number of the Sensibo device.
String
Temperature unit that the Sensibo device displays: C or F.
Object
Metadata for a SmartThings device.
Show properties
String
Device ID for a SmartThings device.
String
Device name for a SmartThings device.
String
Location ID for a SmartThings device.
String
Model for a SmartThings device.
Object
Metadata for a tado° device.
Show properties
Array of Strings
Serial numbers of all tado° devices in the zone.
String
Device type of the main tado° device in the zone, such as RU02, VA02 or WR02.
String
Generation of the tado° home, such as PRE_LINE_X.
String
ID of the tado° home.
String
Name of the tado° home.
String
Serial number of the main tado° device in the zone, such as its wall thermostat or Smart AC Control.
String
ID of the tado° zone within its home.
String
Name of the tado° zone.
String
Type of the tado° zone: HEATING or AIR_CONDITIONING.
Object
Metadata for a Tapo camera.
Show properties
String
Firmware version reported by the camera.
String
Hardware version reported by the camera.
String
Model reported by the Tapo camera.
Object
Metadata for a Tedee device.
Show properties
Number
Bridge ID for a Tedee device.
String
Bridge name for a Tedee device.
Number
Device ID for a Tedee device.
String
Device model for a Tedee device.
String
Device name for a Tedee device.
Number
Keypad ID for a Tedee device.
String
Serial number for a Tedee device.
Object
Metadata for a TTLock device.
Show properties
String
Feature value for a TTLock device.
Object
Features for a TTLock device.
Show properties
Boolean
Indicates whether a TTLock device supports auto-lock time configuration.
Boolean
Indicates whether a TTLock device supports an incomplete keyboard passcode.
Boolean
Indicates whether a TTLock device supports the lock command.
Boolean
Indicates whether a TTLock device supports a passcode.
Boolean
Indicates whether a TTLock device supports passcode management.
Boolean
Indicates whether a TTLock device supports unlock via gateway.
Boolean
Indicates whether a TTLock device supports Wi-Fi.
Boolean
Indicates whether a TTLock device has a gateway.
String
Lock alias for a TTLock device.
Number
Lock ID for a TTLock device.
Number or null
Lock-side timezone offset in milliseconds east of UTC, as configured in the TTLock app. Source of truth for the lock’s wall-clock interpretation of access code start/end times — a misconfigured value here is the typical cause of customer “codes offset by N hours” reports. Diagnostic only; Seam does not convert times based on this value.
Array of Objects
Wireless keypads for a TTLock device.
Show properties
Number
ID for a wireless keypad for a TTLock device.
String
Name for a wireless keypad for a TTLock device.
Object
Metadata for a Tuya device.
Show properties
String
Tuya product category code for the device (e.g. ms).
String
Device ID for a Tuya device.
String
Device name for a Tuya device.
String or null
Model reported for a Tuya device.
String
Tuya product ID for the device.
String
Tuya product name for the device.
String or null
Time zone reported for a Tuya device (e.g. +08:00).
Object
Metadata for a 2N device.
Show properties
Number
Device ID for a 2N device.
String
Device name for a 2N device.
Object
Metadata for an Ultraloq device.
Show properties
String
Device ID for an Ultraloq device.
String
Device name for an Ultraloq device.
String
Device type for an Ultraloq device.
String or null
IANA timezone for the Ultraloq device.
Object
Metadata for a UniFi Protect camera.
Show properties
String
Camera ID reported by UniFi Protect.
String
Camera name reported by UniFi Protect.
Boolean
Whether the camera has a microphone.
String
MAC address reported by the UniFi Protect camera.
String
Model reported by the UniFi Protect camera.
String
Name of the UniFi Protect console that manages the camera.
Object
Metadata for an ASSA ABLOY Visionline system.
Show properties
String
Encoder ID for an ASSA ABLOY Visionline system.
Object
Metadata for a Wyze device.
Show properties
String
Device ID for a Wyze device.
String
Device information model for a Wyze device.
String
Device name for a Wyze device.
String
Keypad UUID for a Wyze device.
Number
Locker status (hardlock) for a Wyze device.
String
Product model for a Wyze device.
String
Product name for a Wyze device.
String
Product type for a Wyze device.
Object
Metadata for a Yacan device.
Show properties
String
Device ID for a Yacan device.
String
Device name for a Yacan device.
String
Device type for a Yacan device.
String
Serial number for a Yacan device.
Object
Metadata for a Yale Connect lock.
Show properties
String
Device ID for a Yale Connect lock.
String
Device name for a Yale Connect lock.
String
Firmware version reported by the Yale Connect lock.
String
Name of the Yale Connect home that contains the lock.
String
Model reported by the Yale Connect lock.
String
Time zone of the Yale Connect home, as Yale reports it.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Seam","colors":{"primary":"#4C45D9","light":"#9793EC","dark":"#2E27B9"},"logo":{"light":"https://mintcdn.com/seam/RVHI-5qT0fl5Zkft/images/seam-logo-light.svg?fit=max\u0026auto=format\u0026n=RVHI-5qT0fl5Zkft\u0026q=85\u0026s=4529d092246aab7709a6692a7cdccf39","dark":"https://mintcdn.com/seam/RVHI-5qT0fl5Zkft/images/seam-logo-dark.svg?fit=max\u0026auto=format\u0026n=RVHI-5qT0fl5Zkft\u0026q=85\u0026s=03fb0cba588d1fe9509b748f460ec77f"},"favicon":"https://mintcdn.com/seam/nEtd2JDrEIRXJ8-h/images/favicon.svg?fit=max\u0026auto=format\u0026n=nEtd2JDrEIRXJ8-h\u0026q=85\u0026s=387df3cc957aa637bdc0aae7bd0fd44f","api":{"playground":{"display":"simple"},"examples":{"autogenerate":false}},"background":{"color":{"light":"#FFFFFF","dark":"#090A0B"}},"navbar":{"links":[{"href":"https://console.seam.co/signin?utm_source=docs\u0026utm_medium=navbar","label":"Sign In"}],"primary":{"type":"button","label":"Sign Up","href":"https://console.seam.co/signup?utm_source=docs\u0026utm_medium=navbar"}},"footer":{"socials":{"github":"https://github.com/seamapi","website":"https://www.seam.co/"}},"seo":{"metatags":{"og:type":"website","og:site_name":"Seam","og:locale":"en_US","og:image":"https://www.seam.co/docs/images/seam-og-default.jpg","twitter:card":"summary_large_image","twitter:site":"@helloseam"},"indexing":"navigable"},"styling":{"codeblocks":"dark","latex":false},"integrations":{"ga4":{"measurementId":"G-WEDP4R501R"},"posthog":{"apiKey":"phc_uGxZi2ITs4kTMqcVibHr6wVWhJ1YKA2LpCbldvd3GYN","apiHost":"https://us.i.posthog.com"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"seam","hasAudioNarration":false,"actualSubdomain":"seam","customDomains":["www.seam.co"],"gitSource":{"type":"github","owner":"seamapi","repo":"docs","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"issues":false,"edits":false},"entitlements":{},"buildId":"6b00497e27f1c1b912490be0","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":336},{"language":"default","tag":"Brand Guides","count":262},{"language":"default","tag":"Guides","count":198},{"language":"default","tag":"Devices and Systems","count":143},{"language":"default","tag":"Access Control Systems","count":124},{"language":"default","tag":"Smart Locks","count":102},{"language":"default","tag":"Thermostats","count":80},{"language":"default","tag":"Low-Level APIs","count":74},{"language":"default","tag":"Setup","count":72},{"language":"default","tag":"Access Control Systems (ACS)","count":63}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".seam-property-index{max-height:20rem;overflow-y:auto;padding:0.75rem;border-radius:0.5rem;background:var(--seam-surface-2)}a.seam-ref{display:block;font-size:0.875rem;scroll-margin-top:10rem}.seam-brand-cover-source,#header>.seam-brand-cover{overflow:hidden;border-radius:0.5rem}#header>.seam-brand-cover{width:100%;margin:0 0 2rem}.seam-brand-cover-light,.seam-brand-cover-dark{display:block;width:100%;height:auto;aspect-ratio:16 / 9;object-fit:cover;margin:0}.seam-brand-cover-dark,.dark .seam-brand-cover-light{display:none}.dark .seam-brand-cover-dark{display:block}#content-area:has(#header>.seam-brand-cover) .seam-brand-cover-source{display:none}:root{--seam-primary-50: #e9e8fc;--seam-primary-100: #d4d2f9;--seam-primary-300: #9793ec;--seam-primary-400: #625ae2;--seam-primary-500: #4c45d9;--seam-primary-600: #2e27b9;--seam-primary-900: #0e1044;--seam-gray-25: #ffffff;--seam-gray-50: #eeeff2;--seam-gray-100: #e5e7eb;--seam-gray-200: #ccd0d7;--seam-gray-300: #acb2be;--seam-gray-400: #848b9a;--seam-gray-500: #5c6475;--seam-gray-600: #505668;--seam-gray-700: #31353f;--seam-gray-800: #282a30;--seam-gray-900: #191b1f;--seam-gray-950: #090a0b;--seam-txt-1: var(--seam-gray-950);--seam-txt-2: var(--seam-gray-500);--seam-txt-3: var(--seam-gray-400);--seam-surface-1: var(--seam-gray-25);--seam-surface-2: color-mix(in srgb, var(--seam-gray-50) 20%, var(--seam-gray-25));--seam-surface-3: var(--seam-gray-100);--seam-surface-4: var(--seam-gray-200);--seam-card: #ffffff;--seam-card-hover: rgb(240 240 240);--seam-accent: var(--seam-primary-500);--seam-accent-hover: var(--seam-primary-400);--seam-accent-text: var(--seam-primary-600);--seam-stroke: 0 0 0 0.5px rgb(9 10 11 / 0.1) inset}.dark{--seam-txt-1: var(--seam-gray-50);--seam-txt-2: var(--seam-gray-400);--seam-txt-3: var(--seam-gray-500);--seam-surface-1: var(--seam-gray-950);--seam-surface-2: color-mix(in srgb, var(--seam-gray-950) 99%, #737373);--seam-surface-3: var(--seam-gray-900);--seam-surface-4: color-mix(in srgb, var(--seam-gray-900) 95%, #fff);--seam-card: color-mix(in srgb, var(--seam-gray-900) 30%, #111);--seam-card-hover: color-mix(in srgb, var(--seam-gray-900) 60%, #242424);--seam-accent: var(--seam-primary-400);--seam-accent-hover: var(--seam-primary-300);--seam-accent-text: var(--seam-primary-300);--seam-stroke: 0 0 0 0.5px rgb(255 255 255 / 0.1) inset}.seam-container{max-width:1120px;margin:0 auto;padding:0 1.5rem}.seam-section{padding:4rem 0}.seam-section-alt{background:var(--seam-surface-2);box-shadow:0 0.5px 0 0 rgb(9 10 11 / 0.1) inset,\n 0 -0.5px 0 0 rgb(9 10 11 / 0.1) inset}.dark .seam-section-alt{box-shadow:0 0.5px 0 0 rgb(255 255 255 / 0.08) inset,\n 0 -0.5px 0 0 rgb(255 255 255 / 0.08) inset}.seam-hero{padding:5rem 0 3rem;background:radial-gradient(\n 60% 50% at 50% 0%,\n color-mix(in srgb, var(--seam-primary-500) 10%, transparent),\n transparent 70%\n )}.dark .seam-hero{background:radial-gradient(\n 60% 50% at 50% 0%,\n color-mix(in srgb, var(--seam-primary-400) 16%, transparent),\n transparent 70%\n )}.seam-h1{font-size:clamp(2rem, 4.5vw, 3.25rem);line-height:1.1;font-weight:600;letter-spacing:-0.03em;color:var(--seam-txt-1);max-width:20ch;margin:0 0 1.25rem}.seam-lede{font-size:1.125rem;line-height:1.6;max-width:60ch;color:var(--seam-txt-2);margin:0 0 3.5rem}.seam-h2{font-size:1.5rem;font-weight:600;letter-spacing:-0.02em;color:var(--seam-txt-1);margin:0 0 0.5rem}.seam-sub{color:var(--seam-txt-2);margin:0 0 1.75rem;max-width:65ch}.seam-btn{display:inline-flex;align-items:center;padding:0.625rem 1.125rem;border-radius:0.5rem;font-weight:525;font-size:0.9375rem;text-decoration:none!important;transition:background 120ms,\n box-shadow 120ms}.seam-btn-primary{background:var(--seam-gray-950);color:#fff!important;box-shadow:0 12px 16px 0 rgb(255 255 255 / 0.06) inset,\n 0 4px 4px 0 rgb(9 10 11 / 0.08),\n 0 1px 2px 0 rgb(9 10 11 / 0.1)}.seam-btn-primary:hover{background:var(--seam-gray-800)}.dark .seam-btn-primary{background:#fff;color:var(--seam-gray-950)!important}.dark .seam-btn-primary:hover{background:var(--seam-gray-100)}.seam-btn-secondary{background:var(--seam-card);color:var(--seam-txt-1)!important;box-shadow:var(--seam-stroke)}.seam-btn-secondary:hover{background:var(--seam-card-hover)}#topbar-cta-button a>span.absolute{background:var(--seam-gray-950)!important}#topbar-cta-button a:hover>span.absolute{background:var(--seam-gray-800)!important;opacity:1!important}.dark #topbar-cta-button a>span.absolute{background:#fff!important}.dark #topbar-cta-button a .z-10 span,.dark #topbar-cta-button a svg{color:var(--seam-gray-950)!important}.seam-path-grid{display:grid;grid-template-columns:1.35fr 1fr;gap:1.25rem;align-items:stretch}@media (max-width: 800px){.seam-path-grid{grid-template-columns:1fr}}.seam-agent-card,.seam-quickstart-card{display:flex;flex-direction:column;align-items:flex-start;padding:1.75rem;border-radius:0.75rem;background:var(--seam-card)}.seam-agent-card{background:var(--seam-gray-950);box-shadow:0 0.5px 0 0 #090a0b inset,\n 0 1px 0 0 rgb(255 255 255 / 0.12) inset,\n 0 12px 24px 0 rgb(9 10 11 / 0.12)}.seam-agent-card .seam-agent-title{color:#fff}.seam-agent-card .seam-agent-desc{color:var(--seam-gray-300)}.dark .seam-agent-card{background:var(--seam-gray-900)}.seam-agent-card .code-block{background:transparent;box-shadow:none;border:none;padding:0}.seam-agent-card .code-block [data-component-part=\"code-block-header\"]{display:none}.seam-agent-code{position:relative}.seam-agent-code::before{content:'';display:block;height:1px;width:88%;background:rgb(255 255 255 / 0.14);margin:0.25rem 0 1rem}.seam-quickstart-card{background:var(--seam-surface-2);box-shadow:var(--seam-stroke)}.seam-agent-title{font-size:1.25rem;font-weight:600;letter-spacing:-0.02em;color:var(--seam-txt-1);margin:0 0 0.5rem}.seam-agent-desc{font-size:0.8125rem;line-height:1.55;color:var(--seam-txt-2);margin:0 0 1rem}.seam-agent-code{width:100%;margin-top:auto}.seam-agent-code pre{margin:0;font-size:0.875rem}.seam-quickstart-cta{margin-top:auto;margin-left:auto}.seam-open-menu{position:absolute;right:0;bottom:0;z-index:10}.seam-open-btn{cursor:pointer;font-size:0.9375rem;font-weight:525;line-height:1.5;color:var(--seam-gray-950);background:#fff;border:none;border-radius:0.5rem;padding:0.625rem 1.125rem;box-shadow:0 2px 8px 0 rgb(9 10 11 / 0.35);transition:background 120ms,\n transform 120ms}.seam-open-btn:hover{background:var(--seam-gray-100);transform:translateY(-1px)}.seam-open-list{display:none;position:absolute;right:0;top:calc(100% + 0.375rem);z-index:30;min-width:11.5rem;flex-direction:column;padding:0.25rem;border-radius:0.5rem;background:var(--seam-gray-800);box-shadow:0 0 0 0.5px rgb(255 255 255 / 0.12) inset,\n 0 8px 24px 0 rgb(9 10 11 / 0.4)}.seam-open-menu.open .seam-open-list{display:flex}.seam-open-list a,.seam-open-list button{text-align:left;font-size:0.8125rem;font-weight:475;color:rgb(255 255 255 / 0.9)!important;text-decoration:none!important;background:none;border:none;cursor:pointer;padding:0.4375rem 0.625rem;border-radius:0.375rem;white-space:nowrap}.seam-open-list a:hover,.seam-open-list button:hover{background:rgb(255 255 255 / 0.1)}.seam-agent-code .code-block,.seam-hero-cell .code-block{margin:0}.seam-code-label{font-size:0.75rem;font-weight:600;letter-spacing:0.08em;text-transform:uppercase;color:var(--seam-txt-3);margin:0 0 0.625rem}.seam-section .card h2,.seam-section [class*=\"card\"] h2{font-size:0.9375rem}.seam-sdk-row{display:flex;flex-wrap:wrap;gap:0.625rem}.seam-sdk{display:inline-flex;align-items:center;gap:0.5rem;padding:0.5rem 0.875rem;border-radius:0.5rem;font-size:0.875rem;font-weight:525;color:var(--seam-txt-1)!important;text-decoration:none!important;background:var(--seam-card);box-shadow:var(--seam-stroke);transition:background 120ms}.seam-sdk:hover{background:var(--seam-card-hover)}.seam-video-grid{display:grid;grid-template-columns:repeat(3, 1fr);gap:1.5rem}@media (max-width: 800px){.seam-video-grid{grid-template-columns:1fr}}.seam-video-frame{position:relative;aspect-ratio:16 / 9;border-radius:0.5rem;overflow:hidden;background:var(--seam-gray-950);box-shadow:var(--seam-stroke)}.seam-video-frame iframe{position:absolute;inset:0;width:100%;height:100%}.seam-video-title{font-weight:525;font-size:0.9375rem;color:var(--seam-txt-1);margin:0.75rem 0 0.125rem}.seam-video-desc{font-size:0.8125rem;color:var(--seam-txt-2);margin:0}.seam-split{display:grid;grid-template-columns:1fr 1.2fr;gap:3rem;align-items:center}@media (max-width: 800px){.seam-split{grid-template-columns:1fr}}.seam-logo-grid{display:grid;grid-template-columns:repeat(4, 1fr);gap:0.75rem}.seam-logo-grid a{display:flex;align-items:center;justify-content:center;height:64px;padding:0.75rem;border-radius:0.5rem;background:var(--seam-card);box-shadow:var(--seam-stroke);transition:background 120ms}.seam-logo-grid a:hover{background:var(--seam-card-hover)}.seam-logo-grid img{max-height:32px;max-width:100%;object-fit:contain;margin:0}.dark .seam-logo-grid a{background:var(--seam-gray-50)}.dark .seam-logo-grid a:hover{background:var(--seam-gray-100)}.seam-footer-strip{padding-top:2rem;padding-bottom:5rem}"}]}
{"page":{"pagePath":"api/devices/properties","slug":"/api/devices/properties","pageMetadata":{"title":"Common Device Properties","description":"Reference shared device properties and provider metadata for Seam devices, including smart locks, thermostats, sensors, and connected hardware.","href":"/api/devices/properties"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Reference shared device properties and provider metadata for Seam devices, including smart locks, thermostats, sensors, and connected hardware.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,hr:`hr`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,Expandable,Heading,ResponseField}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`shared-device-properties`,children:`Shared Device Properties`}),`\n`,_jsxs(_components.p,{children:[`These fields appear within `,_jsx(_components.code,{children:`device.properties`}),`. For capability-specific properties and complete examples, see `,_jsx(_components.a,{href:`https://www.seam.co/docs/api/devices/object`,children:`The Device Object`}),`, `,_jsx(_components.a,{href:`https://www.seam.co/docs/api/locks/object`,children:`The Lock Object`}),`, or `,_jsx(_components.a,{href:`https://www.seam.co/docs/api/thermostats/object`,children:`The Thermostat Object`}),`.`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`properties`,children:`Properties`}),`\n`,_jsxs(ResponseField,{name:`model`,id:`device-properties-model`,type:`Object`,required:true,children:[_jsx(_components.p,{children:`Device model-related properties.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`can_connect_accessory_keypad`,id:`device-properties-model-can-connect-accessory-keypad`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether the device can connect a accessory keypad.`})}),_jsx(ResponseField,{name:`display_name`,id:`device-properties-model-display-name`,type:`String`,required:true,children:_jsx(_components.p,{children:`Display name of the device model.`})}),_jsx(ResponseField,{name:`has_built_in_keypad`,id:`device-properties-model-has-built-in-keypad`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether the device has a built in accessory keypad.`})}),_jsx(ResponseField,{name:`manufacturer_display_name`,id:`device-properties-model-manufacturer-display-name`,type:`String`,required:true,children:_jsx(_components.p,{children:`Display name that corresponds to the manufacturer-specific terminology for the device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`name`,id:`device-properties-name`,type:`String`,required:true,deprecated:true,children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Deprecated`}),`. use device.display_name instead`]}),_jsx(_components.p,{children:`Name of the device.`})]}),`\n`,_jsx(ResponseField,{name:`online`,id:`device-properties-online`,type:`Boolean`,required:true,children:_jsx(_components.p,{children:`Indicates whether the device is online.`})}),`\n`,_jsxs(ResponseField,{name:`assa_abloy_credential_service_metadata`,id:`device-properties-assa-abloy-credential-service-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`ASSA ABLOY Credential Service metadata for the phone.`}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`endpoints`,id:`device-properties-assa-abloy-credential-service-metadata-endpoints`,type:`Array of Objects`,children:[_jsx(_components.p,{children:`Endpoints associated with the phone.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`endpoint_id`,id:`device-properties-assa-abloy-credential-service-metadata-endpoints-endpoint-id`,type:`String`,children:_jsx(_components.p,{children:`ID of the associated endpoint.`})}),_jsx(ResponseField,{name:`is_active`,id:`device-properties-assa-abloy-credential-service-metadata-endpoints-is-active`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicated whether the endpoint is active.`})})]})]}),_jsx(ResponseField,{name:`has_active_endpoint`,id:`device-properties-assa-abloy-credential-service-metadata-has-active-endpoint`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether the credential service has active endpoints associated with the phone.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`salto_space_credential_service_metadata`,id:`device-properties-salto-space-credential-service-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Salto Space credential service metadata for the phone.`}),_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`has_active_phone`,id:`device-properties-salto-space-credential-service-metadata-has-active-phone`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether the credential service has an active associated phone.`})})})]}),`\n`,_jsxs(ResponseField,{name:`akiles_metadata`,id:`device-properties-akiles-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for an Akiles device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`gadget_id`,id:`device-properties-akiles-metadata-gadget-id`,type:`String`,children:_jsx(_components.p,{children:`Gadget ID for an Akiles device.`})}),_jsx(ResponseField,{name:`gadget_name`,id:`device-properties-akiles-metadata-gadget-name`,type:`String`,children:_jsx(_components.p,{children:`Gadget name for an Akiles device.`})}),_jsx(ResponseField,{name:`product_name`,id:`device-properties-akiles-metadata-product-name`,type:`String`,children:_jsx(_components.p,{children:`Product name for an Akiles device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`aqara_metadata`,id:`device-properties-aqara-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for an Aqara device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_name`,id:`device-properties-aqara-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for an Aqara device.`})}),_jsx(ResponseField,{name:`did`,id:`device-properties-aqara-metadata-did`,type:`String`,children:_jsx(_components.p,{children:`Device ID (did) for an Aqara device.`})}),_jsx(ResponseField,{name:`firmware_version`,id:`device-properties-aqara-metadata-firmware-version`,type:`String or null`,children:_jsx(_components.p,{children:`Firmware version for an Aqara device.`})}),_jsx(ResponseField,{name:`model`,id:`device-properties-aqara-metadata-model`,type:`String`,children:_jsx(_components.p,{children:`Model identifier for an Aqara device.`})}),_jsx(ResponseField,{name:`model_type`,id:`device-properties-aqara-metadata-model-type`,type:`Number`,children:_jsx(_components.p,{children:`Model type for an Aqara device.`})}),_jsx(ResponseField,{name:`parent_did`,id:`device-properties-aqara-metadata-parent-did`,type:`String`,children:_jsx(_components.p,{children:`Parent gateway device ID for an Aqara device.`})}),_jsx(ResponseField,{name:`position_id`,id:`device-properties-aqara-metadata-position-id`,type:`String or null`,children:_jsx(_components.p,{children:`Position (room) ID for an Aqara device.`})}),_jsx(ResponseField,{name:`time_zone`,id:`device-properties-aqara-metadata-time-zone`,type:`String or null`,children:_jsx(_components.p,{children:`Time zone reported for an Aqara device (e.g. GMT-07:00).`})})]})]}),`\n`,_jsxs(ResponseField,{name:`arlo_metadata`,id:`device-properties-arlo-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for an Arlo camera.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-arlo-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID reported by Arlo.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-arlo-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name reported by Arlo.`})}),_jsx(ResponseField,{name:`firmware_version`,id:`device-properties-arlo-metadata-firmware-version`,type:`String`,children:_jsx(_components.p,{children:`Firmware version reported by Arlo.`})}),_jsx(ResponseField,{name:`hardware_version`,id:`device-properties-arlo-metadata-hardware-version`,type:`String`,children:_jsx(_components.p,{children:`Hardware version reported by Arlo.`})}),_jsx(ResponseField,{name:`model_id`,id:`device-properties-arlo-metadata-model-id`,type:`String`,children:_jsx(_components.p,{children:`Model ID reported by Arlo.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`assa_abloy_vostio_metadata`,id:`device-properties-assa-abloy-vostio-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for an ASSA ABLOY Vostio system.`}),_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`encoder_name`,id:`device-properties-assa-abloy-vostio-metadata-encoder-name`,type:`String`,children:_jsx(_components.p,{children:`Encoder name for an ASSA ABLOY Vostio system.`})})})]}),`\n`,_jsxs(ResponseField,{name:`august_metadata`,id:`device-properties-august-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for an August device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`has_keypad`,id:`device-properties-august-metadata-has-keypad`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether an August device has a keypad.`})}),_jsx(ResponseField,{name:`house_id`,id:`device-properties-august-metadata-house-id`,type:`String`,children:_jsx(_components.p,{children:`House ID for an August device.`})}),_jsx(ResponseField,{name:`house_name`,id:`device-properties-august-metadata-house-name`,type:`String`,children:_jsx(_components.p,{children:`House name for an August device.`})}),_jsx(ResponseField,{name:`keypad_battery_level`,id:`device-properties-august-metadata-keypad-battery-level`,type:`String`,children:_jsx(_components.p,{children:`Keypad battery level for an August device.`})}),_jsx(ResponseField,{name:`lock_id`,id:`device-properties-august-metadata-lock-id`,type:`String`,children:_jsx(_components.p,{children:`Lock ID for an August device.`})}),_jsx(ResponseField,{name:`lock_name`,id:`device-properties-august-metadata-lock-name`,type:`String`,children:_jsx(_components.p,{children:`Lock name for an August device.`})}),_jsx(ResponseField,{name:`model`,id:`device-properties-august-metadata-model`,type:`String`,children:_jsx(_components.p,{children:`Model for an August device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`avigilon_alta_metadata`,id:`device-properties-avigilon-alta-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for an Avigilon Alta system.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`entry_name`,id:`device-properties-avigilon-alta-metadata-entry-name`,type:`String`,children:_jsx(_components.p,{children:`Entry name for an Avigilon Alta system.`})}),_jsx(ResponseField,{name:`entry_relays_total_count`,id:`device-properties-avigilon-alta-metadata-entry-relays-total-count`,type:`Number`,children:_jsx(_components.p,{children:`Total count of entry relays for an Avigilon Alta system.`})}),_jsx(ResponseField,{name:`org_name`,id:`device-properties-avigilon-alta-metadata-org-name`,type:`String`,children:_jsx(_components.p,{children:`Organization name for an Avigilon Alta system.`})}),_jsx(ResponseField,{name:`site_id`,id:`device-properties-avigilon-alta-metadata-site-id`,type:`Number`,children:_jsx(_components.p,{children:`Site ID for an Avigilon Alta system.`})}),_jsx(ResponseField,{name:`site_name`,id:`device-properties-avigilon-alta-metadata-site-name`,type:`String`,children:_jsx(_components.p,{children:`Site name for an Avigilon Alta system.`})}),_jsx(ResponseField,{name:`zone_id`,id:`device-properties-avigilon-alta-metadata-zone-id`,type:`Number`,children:_jsx(_components.p,{children:`Zone ID for an Avigilon Alta system.`})}),_jsx(ResponseField,{name:`zone_name`,id:`device-properties-avigilon-alta-metadata-zone-name`,type:`String`,children:_jsx(_components.p,{children:`Zone name for an Avigilon Alta system.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`brivo_metadata`,id:`device-properties-brivo-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Brivo device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`activation_enabled`,id:`device-properties-brivo-metadata-activation-enabled`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether the Brivo access point has activation (remote unlock) enabled.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-brivo-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Brivo device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`controlbyweb_metadata`,id:`device-properties-controlbyweb-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a ControlByWeb device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-controlbyweb-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a ControlByWeb device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-controlbyweb-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a ControlByWeb device.`})}),_jsx(ResponseField,{name:`relay_name`,id:`device-properties-controlbyweb-metadata-relay-name`,type:`String or null`,children:_jsx(_components.p,{children:`Relay name for a ControlByWeb device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`dormakaba_oracode_iho_metadata`,id:`device-properties-dormakaba-oracode-iho-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a dormakaba Oracode Homeowner’s Portal device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`door_id`,id:`device-properties-dormakaba-oracode-iho-metadata-door-id`,type:`Number`,children:_jsx(_components.p,{children:`Door ID for a dormakaba Oracode Homeowner’s Portal device.`})}),_jsx(ResponseField,{name:`door_name`,id:`device-properties-dormakaba-oracode-iho-metadata-door-name`,type:`String`,children:_jsx(_components.p,{children:`Name of the door for a dormakaba Oracode Homeowner’s Portal device.`})}),_jsx(ResponseField,{name:`iana_timezone`,id:`device-properties-dormakaba-oracode-iho-metadata-iana-timezone`,type:`String`,children:_jsx(_components.p,{children:`IANA time zone for a dormakaba Oracode Homeowner’s Portal device.`})}),_jsxs(ResponseField,{name:`user_levels`,id:`device-properties-dormakaba-oracode-iho-metadata-user-levels`,type:`Array of Objects`,children:[_jsx(_components.p,{children:`User levels for a dormakaba Oracode Homeowner’s Portal device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`user_level`,id:`device-properties-dormakaba-oracode-iho-metadata-user-levels-user-level`,type:`Number`,children:_jsx(_components.p,{children:`The user level.`})}),_jsx(ResponseField,{name:`user_level_check_in_time`,id:`device-properties-dormakaba-oracode-iho-metadata-user-levels-user-level-check-in-time`,type:`String`,children:_jsx(_components.p,{children:`The user level check in time.`})}),_jsx(ResponseField,{name:`user_level_check_out_time`,id:`device-properties-dormakaba-oracode-iho-metadata-user-levels-user-level-check-out-time`,type:`String`,children:_jsx(_components.p,{children:`The user level check out time.`})}),_jsx(ResponseField,{name:`user_level_name`,id:`device-properties-dormakaba-oracode-iho-metadata-user-levels-user-level-name`,type:`String`,children:_jsx(_components.p,{children:`The user level name.`})}),_jsx(ResponseField,{name:`user_level_type`,id:`device-properties-dormakaba-oracode-iho-metadata-user-levels-user-level-type`,type:`String`,children:_jsx(_components.p,{children:`The user level type.`})})]})]})]})]}),`\n`,_jsxs(ResponseField,{name:`dormakaba_oracode_metadata`,id:`device-properties-dormakaba-oracode-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a dormakaba Oracode device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-dormakaba-oracode-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a dormakaba Oracode device.`})}),_jsx(ResponseField,{name:`door_id`,id:`device-properties-dormakaba-oracode-metadata-door-id`,type:`Number`,children:_jsx(_components.p,{children:`Door ID for a dormakaba Oracode device.`})}),_jsx(ResponseField,{name:`door_is_wireless`,id:`device-properties-dormakaba-oracode-metadata-door-is-wireless`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether a door is wireless for a dormakaba Oracode device.`})}),_jsx(ResponseField,{name:`door_name`,id:`device-properties-dormakaba-oracode-metadata-door-name`,type:`String`,children:_jsx(_components.p,{children:`Door name for a dormakaba Oracode device.`})}),_jsx(ResponseField,{name:`iana_timezone`,id:`device-properties-dormakaba-oracode-metadata-iana-timezone`,type:`String`,children:_jsx(_components.p,{children:`IANA time zone for a dormakaba Oracode device.`})}),_jsxs(ResponseField,{name:`predefined_time_slots`,id:`device-properties-dormakaba-oracode-metadata-predefined-time-slots`,type:`Array of Objects`,children:[_jsx(_components.p,{children:`Predefined time slots for a dormakaba Oracode device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`check_in_time`,id:`device-properties-dormakaba-oracode-metadata-predefined-time-slots-check-in-time`,type:`String`,children:_jsx(_components.p,{children:`Check in time for a time slot for a dormakaba Oracode device.`})}),_jsx(ResponseField,{name:`check_out_time`,id:`device-properties-dormakaba-oracode-metadata-predefined-time-slots-check-out-time`,type:`String`,children:_jsx(_components.p,{children:`Checkout time for a time slot for a dormakaba Oracode device.`})}),_jsx(ResponseField,{name:`dormakaba_oracode_user_level_id`,id:`device-properties-dormakaba-oracode-metadata-predefined-time-slots-dormakaba-oracode-user-level-id`,type:`String (UUID)`,children:_jsx(_components.p,{children:`ID of a user level for a dormakaba Oracode device.`})}),_jsx(ResponseField,{name:`dormakaba_oracode_user_level_prefix`,id:`device-properties-dormakaba-oracode-metadata-predefined-time-slots-dormakaba-oracode-user-level-prefix`,type:`Number`,children:_jsx(_components.p,{children:`Prefix for a user level for a dormakaba Oracode device.`})}),_jsx(ResponseField,{name:`is_24_hour`,id:`device-properties-dormakaba-oracode-metadata-predefined-time-slots-is-24-hour`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot.`})}),_jsx(ResponseField,{name:`is_biweekly_mode`,id:`device-properties-dormakaba-oracode-metadata-predefined-time-slots-is-biweekly-mode`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode.`})}),_jsx(ResponseField,{name:`is_master`,id:`device-properties-dormakaba-oracode-metadata-predefined-time-slots-is-master`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether a time slot for a dormakaba Oracode device is a master time slot.`})}),_jsx(ResponseField,{name:`is_one_shot`,id:`device-properties-dormakaba-oracode-metadata-predefined-time-slots-is-one-shot`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot.`})}),_jsx(ResponseField,{name:`name`,id:`device-properties-dormakaba-oracode-metadata-predefined-time-slots-name`,type:`String`,children:_jsx(_components.p,{children:`Name of a time slot for a dormakaba Oracode device.`})}),_jsx(ResponseField,{name:`prefix`,id:`device-properties-dormakaba-oracode-metadata-predefined-time-slots-prefix`,type:`Number`,children:_jsx(_components.p,{children:`Prefix for a time slot for a dormakaba Oracode device.`})})]})]}),_jsx(ResponseField,{name:`site_name`,id:`device-properties-dormakaba-oracode-metadata-site-name`,type:`String`,children:_jsx(_components.p,{children:`Site name for a dormakaba Oracode device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`ecobee_metadata`,id:`device-properties-ecobee-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for an ecobee device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_name`,id:`device-properties-ecobee-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for an ecobee device.`})}),_jsx(ResponseField,{name:`ecobee_device_id`,id:`device-properties-ecobee-metadata-ecobee-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for an ecobee device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`eufy_metadata`,id:`device-properties-eufy-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Eufy device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-eufy-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`The device id.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-eufy-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`The device name.`})}),_jsx(ResponseField,{name:`model`,id:`device-properties-eufy-metadata-model`,type:`String`,children:_jsx(_components.p,{children:`The model.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`four_suites_metadata`,id:`device-properties-four-suites-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a 4SUITES device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-four-suites-metadata-device-id`,type:`Number`,children:_jsx(_components.p,{children:`Device ID for a 4SUITES device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-four-suites-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a 4SUITES device.`})}),_jsx(ResponseField,{name:`reclose_delay_in_seconds`,id:`device-properties-four-suites-metadata-reclose-delay-in-seconds`,type:`Number`,children:_jsx(_components.p,{children:`Reclose delay, in seconds, for a 4SUITES device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`genie_metadata`,id:`device-properties-genie-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Genie device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_name`,id:`device-properties-genie-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Lock name for a Genie device.`})}),_jsx(ResponseField,{name:`door_name`,id:`device-properties-genie-metadata-door-name`,type:`String`,children:_jsx(_components.p,{children:`Door name for a Genie device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`honeywell_resideo_metadata`,id:`device-properties-honeywell-resideo-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Honeywell Resideo device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_name`,id:`device-properties-honeywell-resideo-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Honeywell Resideo device.`})}),_jsx(ResponseField,{name:`honeywell_resideo_device_id`,id:`device-properties-honeywell-resideo-metadata-honeywell-resideo-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a Honeywell Resideo device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`igloo_metadata`,id:`device-properties-igloo-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for an igloo device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`bridge_id`,id:`device-properties-igloo-metadata-bridge-id`,type:`String`,children:_jsx(_components.p,{children:`Bridge ID for an igloo device.`})}),_jsx(ResponseField,{name:`device_id`,id:`device-properties-igloo-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for an igloo device.`})}),_jsx(ResponseField,{name:`model`,id:`device-properties-igloo-metadata-model`,type:`String`,children:_jsx(_components.p,{children:`Model for an igloo device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`igloohome_metadata`,id:`device-properties-igloohome-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for an igloohome device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`bridge_id`,id:`device-properties-igloohome-metadata-bridge-id`,type:`String`,children:_jsx(_components.p,{children:`Bridge ID for an igloohome device.`})}),_jsx(ResponseField,{name:`bridge_name`,id:`device-properties-igloohome-metadata-bridge-name`,type:`String`,children:_jsx(_components.p,{children:`Bridge name for an igloohome device.`})}),_jsx(ResponseField,{name:`device_id`,id:`device-properties-igloohome-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for an igloohome device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-igloohome-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for an igloohome device.`})}),_jsx(ResponseField,{name:`is_accessory_keypad_linked_to_bridge`,id:`device-properties-igloohome-metadata-is-accessory-keypad-linked-to-bridge`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether a keypad is linked to a bridge for an igloohome device.`})}),_jsx(ResponseField,{name:`keypad_id`,id:`device-properties-igloohome-metadata-keypad-id`,type:`String`,children:_jsx(_components.p,{children:`Keypad ID for an igloohome device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`keynest_metadata`,id:`device-properties-keynest-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a KeyNest device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`address`,id:`device-properties-keynest-metadata-address`,type:`String or null`,children:_jsx(_components.p,{children:`Address for a KeyNest device.`})}),_jsx(ResponseField,{name:`current_or_last_store_id`,id:`device-properties-keynest-metadata-current-or-last-store-id`,type:`Number`,children:_jsx(_components.p,{children:`Current or last store ID for a KeyNest device.`})}),_jsx(ResponseField,{name:`current_status`,id:`device-properties-keynest-metadata-current-status`,type:`String or null`,children:_jsx(_components.p,{children:`Current status for a KeyNest device.`})}),_jsx(ResponseField,{name:`current_user_company`,id:`device-properties-keynest-metadata-current-user-company`,type:`String or null`,children:_jsx(_components.p,{children:`Current user company for a KeyNest device.`})}),_jsx(ResponseField,{name:`current_user_email`,id:`device-properties-keynest-metadata-current-user-email`,type:`String or null`,children:_jsx(_components.p,{children:`Current user email for a KeyNest device.`})}),_jsx(ResponseField,{name:`current_user_name`,id:`device-properties-keynest-metadata-current-user-name`,type:`String or null`,children:_jsx(_components.p,{children:`Current user name for a KeyNest device.`})}),_jsx(ResponseField,{name:`current_user_phone_number`,id:`device-properties-keynest-metadata-current-user-phone-number`,type:`String or null`,children:_jsx(_components.p,{children:`Current user phone number for a KeyNest device.`})}),_jsx(ResponseField,{name:`default_office_id`,id:`device-properties-keynest-metadata-default-office-id`,type:`Number`,children:_jsx(_components.p,{children:`Default office ID for a KeyNest device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-keynest-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a KeyNest device.`})}),_jsx(ResponseField,{name:`fob_id`,id:`device-properties-keynest-metadata-fob-id`,type:`Number`,children:_jsx(_components.p,{children:`Fob ID for a KeyNest device.`})}),_jsx(ResponseField,{name:`handover_method`,id:`device-properties-keynest-metadata-handover-method`,type:`String or null`,children:_jsx(_components.p,{children:`Handover method for a KeyNest device.`})}),_jsx(ResponseField,{name:`has_photo`,id:`device-properties-keynest-metadata-has-photo`,type:`Boolean`,children:_jsx(_components.p,{children:`Whether the KeyNest device has a photo.`})}),_jsx(ResponseField,{name:`is_quadient_locker`,id:`device-properties-keynest-metadata-is-quadient-locker`,type:`Boolean`,children:_jsx(_components.p,{children:`Whether the key is in a locker that does not support the access codes API.`})}),_jsx(ResponseField,{name:`key_id`,id:`device-properties-keynest-metadata-key-id`,type:`String`,children:_jsx(_components.p,{children:`Key ID for a KeyNest device.`})}),_jsx(ResponseField,{name:`key_notes`,id:`device-properties-keynest-metadata-key-notes`,type:`String or null`,children:_jsx(_components.p,{children:`Key notes for a KeyNest device.`})}),_jsx(ResponseField,{name:`keynest_app_user`,id:`device-properties-keynest-metadata-keynest-app-user`,type:`String or null`,children:_jsx(_components.p,{children:`KeyNest app user for a KeyNest device.`})}),_jsx(ResponseField,{name:`last_movement`,id:`device-properties-keynest-metadata-last-movement`,type:`String`,children:_jsx(_components.p,{children:`Last movement timestamp for a KeyNest device.`})}),_jsx(ResponseField,{name:`property_id`,id:`device-properties-keynest-metadata-property-id`,type:`String or null`,children:_jsx(_components.p,{children:`Property ID for a KeyNest device.`})}),_jsx(ResponseField,{name:`property_postcode`,id:`device-properties-keynest-metadata-property-postcode`,type:`String or null`,children:_jsx(_components.p,{children:`Property postcode for a KeyNest device.`})}),_jsx(ResponseField,{name:`status_type`,id:`device-properties-keynest-metadata-status-type`,type:`String`,children:_jsx(_components.p,{children:`Status type for a KeyNest device.`})}),_jsx(ResponseField,{name:`subscription_plan`,id:`device-properties-keynest-metadata-subscription-plan`,type:`String`,children:_jsx(_components.p,{children:`Subscription plan for a KeyNest device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`kisi_metadata`,id:`device-properties-kisi-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Kisi device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`description`,id:`device-properties-kisi-metadata-description`,type:`String or null`,children:_jsx(_components.p,{children:`Description for a Kisi device.`})}),_jsx(ResponseField,{name:`lock_id`,id:`device-properties-kisi-metadata-lock-id`,type:`Number`,children:_jsx(_components.p,{children:`Lock ID for a Kisi device.`})}),_jsx(ResponseField,{name:`lock_name`,id:`device-properties-kisi-metadata-lock-name`,type:`String`,children:_jsx(_components.p,{children:`Lock name for a Kisi device.`})}),_jsx(ResponseField,{name:`place_name`,id:`device-properties-kisi-metadata-place-name`,type:`String or null`,children:_jsx(_components.p,{children:`Place name for a Kisi device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`korelock_metadata`,id:`device-properties-korelock-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Korelock device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-korelock-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a Korelock device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-korelock-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Korelock device.`})}),_jsx(ResponseField,{name:`firmware_version`,id:`device-properties-korelock-metadata-firmware-version`,type:`String`,children:_jsx(_components.p,{children:`Firmware version for a Korelock device.`})}),_jsx(ResponseField,{name:`location_id`,id:`device-properties-korelock-metadata-location-id`,type:`String or null`,children:_jsx(_components.p,{children:`Location ID for a Korelock device. Required for timebound access codes.`})}),_jsx(ResponseField,{name:`model_code`,id:`device-properties-korelock-metadata-model-code`,type:`String`,children:_jsx(_components.p,{children:`Model code for a Korelock device.`})}),_jsx(ResponseField,{name:`serial_number`,id:`device-properties-korelock-metadata-serial-number`,type:`String`,children:_jsx(_components.p,{children:`Serial number for a Korelock device.`})}),_jsx(ResponseField,{name:`wifi_signal_strength`,id:`device-properties-korelock-metadata-wifi-signal-strength`,type:`Number`,children:_jsx(_components.p,{children:`WiFi signal strength (0-1) for a Korelock device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`kwikset_metadata`,id:`device-properties-kwikset-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Kwikset device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-kwikset-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a Kwikset device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-kwikset-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Kwikset device.`})}),_jsx(ResponseField,{name:`model_number`,id:`device-properties-kwikset-metadata-model-number`,type:`String`,children:_jsx(_components.p,{children:`Model number for a Kwikset device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`lockly_metadata`,id:`device-properties-lockly-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Lockly device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-lockly-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a Lockly device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-lockly-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Lockly device.`})}),_jsx(ResponseField,{name:`model`,id:`device-properties-lockly-metadata-model`,type:`String`,children:_jsx(_components.p,{children:`Model for a Lockly device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`minut_metadata`,id:`device-properties-minut-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Minut device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-minut-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a Minut device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-minut-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Minut device.`})}),_jsxs(ResponseField,{name:`latest_sensor_values`,id:`device-properties-minut-metadata-latest-sensor-values`,type:`Object`,children:[_jsx(_components.p,{children:`Latest sensor values for a Minut device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`accelerometer_z`,id:`device-properties-minut-metadata-latest-sensor-values-accelerometer-z`,type:`Object`,children:[_jsx(_components.p,{children:`Latest accelerometer Z-axis reading for a Minut device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`time`,id:`device-properties-minut-metadata-latest-sensor-values-accelerometer-z-time`,type:`String`,children:_jsx(_components.p,{children:`Time of latest accelerometer Z-axis reading for a Minut device.`})}),_jsx(ResponseField,{name:`value`,id:`device-properties-minut-metadata-latest-sensor-values-accelerometer-z-value`,type:`Number`,children:_jsx(_components.p,{children:`Value of latest accelerometer Z-axis reading for a Minut device.`})})]})]}),_jsxs(ResponseField,{name:`humidity`,id:`device-properties-minut-metadata-latest-sensor-values-humidity`,type:`Object`,children:[_jsx(_components.p,{children:`Latest humidity reading for a Minut device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`time`,id:`device-properties-minut-metadata-latest-sensor-values-humidity-time`,type:`String`,children:_jsx(_components.p,{children:`Time of latest humidity reading for a Minut device.`})}),_jsx(ResponseField,{name:`value`,id:`device-properties-minut-metadata-latest-sensor-values-humidity-value`,type:`Number`,children:_jsx(_components.p,{children:`Value of latest humidity reading for a Minut device.`})})]})]}),_jsxs(ResponseField,{name:`pressure`,id:`device-properties-minut-metadata-latest-sensor-values-pressure`,type:`Object`,children:[_jsx(_components.p,{children:`Latest pressure reading for a Minut device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`time`,id:`device-properties-minut-metadata-latest-sensor-values-pressure-time`,type:`String`,children:_jsx(_components.p,{children:`Time of latest pressure reading for a Minut device.`})}),_jsx(ResponseField,{name:`value`,id:`device-properties-minut-metadata-latest-sensor-values-pressure-value`,type:`Number`,children:_jsx(_components.p,{children:`Value of latest pressure reading for a Minut device.`})})]})]}),_jsxs(ResponseField,{name:`sound`,id:`device-properties-minut-metadata-latest-sensor-values-sound`,type:`Object`,children:[_jsx(_components.p,{children:`Latest sound reading for a Minut device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`time`,id:`device-properties-minut-metadata-latest-sensor-values-sound-time`,type:`String`,children:_jsx(_components.p,{children:`Time of latest sound reading for a Minut device.`})}),_jsx(ResponseField,{name:`value`,id:`device-properties-minut-metadata-latest-sensor-values-sound-value`,type:`Number`,children:_jsx(_components.p,{children:`Value of latest sound reading for a Minut device.`})})]})]}),_jsxs(ResponseField,{name:`temperature`,id:`device-properties-minut-metadata-latest-sensor-values-temperature`,type:`Object`,children:[_jsx(_components.p,{children:`Latest temperature reading for a Minut device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`time`,id:`device-properties-minut-metadata-latest-sensor-values-temperature-time`,type:`String`,children:_jsx(_components.p,{children:`Time of latest temperature reading for a Minut device.`})}),_jsx(ResponseField,{name:`value`,id:`device-properties-minut-metadata-latest-sensor-values-temperature-value`,type:`Number`,children:_jsx(_components.p,{children:`Value of latest temperature reading for a Minut device.`})})]})]})]})]})]})]}),`\n`,_jsxs(ResponseField,{name:`nest_metadata`,id:`device-properties-nest-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Google Nest device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_custom_name`,id:`device-properties-nest-metadata-device-custom-name`,type:`String`,children:_jsx(_components.p,{children:`Custom device name for a Google Nest device. The device owner sets this value.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-nest-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Google Nest device. Google sets this value.`})}),_jsx(ResponseField,{name:`display_name`,id:`device-properties-nest-metadata-display-name`,type:`String`,children:_jsx(_components.p,{children:`Name of the Google Home room containing the device. The device owner sets this value.`})}),_jsx(ResponseField,{name:`nest_device_id`,id:`device-properties-nest-metadata-nest-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a Google Nest device.`})}),_jsx(ResponseField,{name:`nest_structure_id`,id:`device-properties-nest-metadata-nest-structure-id`,type:`String`,children:_jsx(_components.p,{children:`ID of the Google Nest structure containing the device.`})}),_jsx(ResponseField,{name:`structure_name`,id:`device-properties-nest-metadata-structure-name`,type:`String`,children:_jsx(_components.p,{children:`Name of the Google Nest structure containing the device. The device owner sets this value.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`noiseaware_metadata`,id:`device-properties-noiseaware-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a NoiseAware device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-noiseaware-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a NoiseAware device.`})}),_jsxs(ResponseField,{name:`device_model`,id:`device-properties-noiseaware-metadata-device-model`,type:`Enum (String)`,children:[_jsx(_components.p,{children:`Device model for a NoiseAware device.`}),_jsx(Accordion,{title:`Enum values`,id:`enum-values`,children:_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`indoor`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`outdoor`})}),`\n`]})})]}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-noiseaware-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a NoiseAware device.`})}),_jsx(ResponseField,{name:`noise_level_decibel`,id:`device-properties-noiseaware-metadata-noise-level-decibel`,type:`Number`,children:_jsx(_components.p,{children:`Noise level, in decibels, for a NoiseAware device.`})}),_jsx(ResponseField,{name:`noise_level_nrs`,id:`device-properties-noiseaware-metadata-noise-level-nrs`,type:`Number`,children:_jsx(_components.p,{children:`Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`nuki_metadata`,id:`device-properties-nuki-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Nuki device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-nuki-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a Nuki device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-nuki-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Nuki device.`})}),_jsx(ResponseField,{name:`keypad_2_paired`,id:`device-properties-nuki-metadata-keypad-2-paired`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether keypad 2 is paired for a Nuki device.`})}),_jsx(ResponseField,{name:`keypad_battery_critical`,id:`device-properties-nuki-metadata-keypad-battery-critical`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether the keypad battery is in a critical state for a Nuki device.`})}),_jsx(ResponseField,{name:`keypad_paired`,id:`device-properties-nuki-metadata-keypad-paired`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether the keypad is paired for a Nuki device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`omnitec_metadata`,id:`device-properties-omnitec-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for an Omnitec device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`has_gateway`,id:`device-properties-omnitec-metadata-has-gateway`,type:`Boolean`,children:_jsx(_components.p,{children:`Whether the Omnitec lock has a connected gateway for remote operations.`})}),_jsx(ResponseField,{name:`lock_alias`,id:`device-properties-omnitec-metadata-lock-alias`,type:`String`,children:_jsx(_components.p,{children:`Operator-assigned alias for an Omnitec device.`})}),_jsx(ResponseField,{name:`lock_id`,id:`device-properties-omnitec-metadata-lock-id`,type:`Number`,children:_jsx(_components.p,{children:`Lock ID for an Omnitec device.`})}),_jsx(ResponseField,{name:`lock_mac`,id:`device-properties-omnitec-metadata-lock-mac`,type:`String`,children:_jsx(_components.p,{children:`Bluetooth MAC address for an Omnitec device.`})}),_jsx(ResponseField,{name:`lock_name`,id:`device-properties-omnitec-metadata-lock-name`,type:`String`,children:_jsx(_components.p,{children:`Lock name for an Omnitec device.`})}),_jsx(ResponseField,{name:`time_zone`,id:`device-properties-omnitec-metadata-time-zone`,type:`String or null`,children:_jsx(_components.p,{children:`IANA time zone for the Omnitec device, used to schedule time-bound access codes at the correct local time (accounting for DST).`})}),_jsx(ResponseField,{name:`timezone_raw_offset_ms`,id:`device-properties-omnitec-metadata-timezone-raw-offset-ms`,type:`Number`,children:_jsx(_components.p,{children:`Static UTC offset of the Omnitec lock in milliseconds. Does not account for DST.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`reolink_metadata`,id:`device-properties-reolink-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Reolink camera.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`firmware_version`,id:`device-properties-reolink-metadata-firmware-version`,type:`String`,children:_jsx(_components.p,{children:`Firmware version reported by the camera.`})}),_jsx(ResponseField,{name:`hardware_version`,id:`device-properties-reolink-metadata-hardware-version`,type:`String`,children:_jsx(_components.p,{children:`Hardware version reported by the camera.`})}),_jsx(ResponseField,{name:`model`,id:`device-properties-reolink-metadata-model`,type:`String`,children:_jsx(_components.p,{children:`Model reported by the Reolink camera.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`ring_metadata`,id:`device-properties-ring-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Ring device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-ring-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a Ring device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-ring-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Ring device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`salto_ks_metadata`,id:`device-properties-salto-ks-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Salto KS device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`battery_level`,id:`device-properties-salto-ks-metadata-battery-level`,type:`String`,children:_jsx(_components.p,{children:`Battery level for a Salto KS device.`})}),_jsx(ResponseField,{name:`customer_reference`,id:`device-properties-salto-ks-metadata-customer-reference`,type:`String`,children:_jsx(_components.p,{children:`Customer reference for a Salto KS device.`})}),_jsx(ResponseField,{name:`has_custom_pin_subscription`,id:`device-properties-salto-ks-metadata-has-custom-pin-subscription`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether the site has a Salto KS subscription that supports custom PINs.`})}),_jsx(ResponseField,{name:`lock_id`,id:`device-properties-salto-ks-metadata-lock-id`,type:`String`,children:_jsx(_components.p,{children:`Lock ID for a Salto KS device.`})}),_jsx(ResponseField,{name:`lock_type`,id:`device-properties-salto-ks-metadata-lock-type`,type:`String`,children:_jsx(_components.p,{children:`Lock type for a Salto KS device.`})}),_jsx(ResponseField,{name:`locked_state`,id:`device-properties-salto-ks-metadata-locked-state`,type:`String`,children:_jsx(_components.p,{children:`Locked state for a Salto KS device.`})}),_jsx(ResponseField,{name:`model`,id:`device-properties-salto-ks-metadata-model`,type:`String`,children:_jsx(_components.p,{children:`Model for a Salto KS device.`})}),_jsx(ResponseField,{name:`site_id`,id:`device-properties-salto-ks-metadata-site-id`,type:`String`,children:_jsx(_components.p,{children:`Site ID for the Salto KS site to which the device belongs.`})}),_jsx(ResponseField,{name:`site_name`,id:`device-properties-salto-ks-metadata-site-name`,type:`String`,children:_jsx(_components.p,{children:`Site name for the Salto KS site to which the device belongs.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`schlage_metadata`,id:`device-properties-schlage-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Schlage device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-schlage-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a Schlage device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-schlage-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Schlage device.`})}),_jsx(ResponseField,{name:`model`,id:`device-properties-schlage-metadata-model`,type:`String`,children:_jsx(_components.p,{children:`Model for a Schlage device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`seam_bridge_metadata`,id:`device-properties-seam-bridge-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for Seam Bridge.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_num`,id:`device-properties-seam-bridge-metadata-device-num`,type:`Number`,children:_jsx(_components.p,{children:`Device number for Seam Bridge.`})}),_jsx(ResponseField,{name:`name`,id:`device-properties-seam-bridge-metadata-name`,type:`String`,children:_jsx(_components.p,{children:`Name for Seam Bridge.`})}),_jsxs(ResponseField,{name:`unlock_method`,id:`device-properties-seam-bridge-metadata-unlock-method`,type:`Enum (String)`,children:[_jsx(_components.p,{children:`Unlock method for Seam Bridge.`}),_jsx(Accordion,{title:`Enum values`,id:`enum-values-1`,children:_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`bridge`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`doorking`})}),`\n`]})})]})]})]}),`\n`,_jsxs(ResponseField,{name:`sensi_metadata`,id:`device-properties-sensi-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Sensi device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-sensi-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a Sensi device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-sensi-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Sensi device.`})}),_jsx(ResponseField,{name:`product_type`,id:`device-properties-sensi-metadata-product-type`,type:`String`,children:_jsx(_components.p,{children:`Product type for a Sensi device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`sensibo_metadata`,id:`device-properties-sensibo-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Sensibo device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`firmware_version`,id:`device-properties-sensibo-metadata-firmware-version`,type:`String`,children:_jsx(_components.p,{children:`Firmware version of the Sensibo device.`})}),_jsx(ResponseField,{name:`mac_address`,id:`device-properties-sensibo-metadata-mac-address`,type:`String`,children:_jsx(_components.p,{children:`MAC address of the Sensibo device.`})}),_jsx(ResponseField,{name:`pod_id`,id:`device-properties-sensibo-metadata-pod-id`,type:`String`,children:_jsx(_components.p,{children:`ID of the Sensibo device, which Sensibo calls a pod.`})}),_jsx(ResponseField,{name:`product_model`,id:`device-properties-sensibo-metadata-product-model`,type:`String`,children:_jsxs(_components.p,{children:[`Product model of the Sensibo device, such as `,_jsx(_components.code,{children:`skyv2`}),` or `,_jsx(_components.code,{children:`skyplus`}),`.`]})}),_jsx(ResponseField,{name:`product_name`,id:`device-properties-sensibo-metadata-product-name`,type:`String`,children:_jsxs(_components.p,{children:[`Product name of the Sensibo device, such as `,_jsx(_components.code,{children:`Sensibo Sky`}),` or `,_jsx(_components.code,{children:`Sensibo Air`}),`.`]})}),_jsx(ResponseField,{name:`room_name`,id:`device-properties-sensibo-metadata-room-name`,type:`String`,children:_jsx(_components.p,{children:`Name of the room that the Sensibo device is in.`})}),_jsx(ResponseField,{name:`serial_number`,id:`device-properties-sensibo-metadata-serial-number`,type:`String`,children:_jsx(_components.p,{children:`Serial number of the Sensibo device.`})}),_jsx(ResponseField,{name:`temperature_unit`,id:`device-properties-sensibo-metadata-temperature-unit`,type:`String`,children:_jsxs(_components.p,{children:[`Temperature unit that the Sensibo device displays: `,_jsx(_components.code,{children:`C`}),` or `,_jsx(_components.code,{children:`F`}),`.`]})})]})]}),`\n`,_jsxs(ResponseField,{name:`smartthings_metadata`,id:`device-properties-smartthings-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a SmartThings device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-smartthings-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a SmartThings device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-smartthings-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a SmartThings device.`})}),_jsx(ResponseField,{name:`location_id`,id:`device-properties-smartthings-metadata-location-id`,type:`String`,children:_jsx(_components.p,{children:`Location ID for a SmartThings device.`})}),_jsx(ResponseField,{name:`model`,id:`device-properties-smartthings-metadata-model`,type:`String`,children:_jsx(_components.p,{children:`Model for a SmartThings device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`tado_metadata`,id:`device-properties-tado-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a tado° device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_serial_numbers`,id:`device-properties-tado-metadata-device-serial-numbers`,type:`Array of Strings`,children:_jsx(_components.p,{children:`Serial numbers of all tado° devices in the zone.`})}),_jsx(ResponseField,{name:`device_type`,id:`device-properties-tado-metadata-device-type`,type:`String`,children:_jsxs(_components.p,{children:[`Device type of the main tado° device in the zone, such as `,_jsx(_components.code,{children:`RU02`}),`, `,_jsx(_components.code,{children:`VA02`}),` or `,_jsx(_components.code,{children:`WR02`}),`.`]})}),_jsx(ResponseField,{name:`home_generation`,id:`device-properties-tado-metadata-home-generation`,type:`String`,children:_jsxs(_components.p,{children:[`Generation of the tado° home, such as `,_jsx(_components.code,{children:`PRE_LINE_X`}),`.`]})}),_jsx(ResponseField,{name:`home_id`,id:`device-properties-tado-metadata-home-id`,type:`String`,children:_jsx(_components.p,{children:`ID of the tado° home.`})}),_jsx(ResponseField,{name:`home_name`,id:`device-properties-tado-metadata-home-name`,type:`String`,children:_jsx(_components.p,{children:`Name of the tado° home.`})}),_jsx(ResponseField,{name:`serial_no`,id:`device-properties-tado-metadata-serial-no`,type:`String`,children:_jsx(_components.p,{children:`Serial number of the main tado° device in the zone, such as its wall thermostat or Smart AC Control.`})}),_jsx(ResponseField,{name:`zone_id`,id:`device-properties-tado-metadata-zone-id`,type:`String`,children:_jsx(_components.p,{children:`ID of the tado° zone within its home.`})}),_jsx(ResponseField,{name:`zone_name`,id:`device-properties-tado-metadata-zone-name`,type:`String`,children:_jsx(_components.p,{children:`Name of the tado° zone.`})}),_jsx(ResponseField,{name:`zone_type`,id:`device-properties-tado-metadata-zone-type`,type:`String`,children:_jsxs(_components.p,{children:[`Type of the tado° zone: `,_jsx(_components.code,{children:`HEATING`}),` or `,_jsx(_components.code,{children:`AIR_CONDITIONING`}),`.`]})})]})]}),`\n`,_jsxs(ResponseField,{name:`tapo_metadata`,id:`device-properties-tapo-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Tapo camera.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`firmware_version`,id:`device-properties-tapo-metadata-firmware-version`,type:`String`,children:_jsx(_components.p,{children:`Firmware version reported by the camera.`})}),_jsx(ResponseField,{name:`hardware_version`,id:`device-properties-tapo-metadata-hardware-version`,type:`String`,children:_jsx(_components.p,{children:`Hardware version reported by the camera.`})}),_jsx(ResponseField,{name:`model`,id:`device-properties-tapo-metadata-model`,type:`String`,children:_jsx(_components.p,{children:`Model reported by the Tapo camera.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`tedee_metadata`,id:`device-properties-tedee-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Tedee device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`bridge_id`,id:`device-properties-tedee-metadata-bridge-id`,type:`Number`,children:_jsx(_components.p,{children:`Bridge ID for a Tedee device.`})}),_jsx(ResponseField,{name:`bridge_name`,id:`device-properties-tedee-metadata-bridge-name`,type:`String`,children:_jsx(_components.p,{children:`Bridge name for a Tedee device.`})}),_jsx(ResponseField,{name:`device_id`,id:`device-properties-tedee-metadata-device-id`,type:`Number`,children:_jsx(_components.p,{children:`Device ID for a Tedee device.`})}),_jsx(ResponseField,{name:`device_model`,id:`device-properties-tedee-metadata-device-model`,type:`String`,children:_jsx(_components.p,{children:`Device model for a Tedee device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-tedee-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Tedee device.`})}),_jsx(ResponseField,{name:`keypad_id`,id:`device-properties-tedee-metadata-keypad-id`,type:`Number`,children:_jsx(_components.p,{children:`Keypad ID for a Tedee device.`})}),_jsx(ResponseField,{name:`serial_number`,id:`device-properties-tedee-metadata-serial-number`,type:`String`,children:_jsx(_components.p,{children:`Serial number for a Tedee device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`ttlock_metadata`,id:`device-properties-ttlock-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a TTLock device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`feature_value`,id:`device-properties-ttlock-metadata-feature-value`,type:`String`,children:_jsx(_components.p,{children:`Feature value for a TTLock device.`})}),_jsxs(ResponseField,{name:`features`,id:`device-properties-ttlock-metadata-features`,type:`Object`,children:[_jsx(_components.p,{children:`Features for a TTLock device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`auto_lock_time_config`,id:`device-properties-ttlock-metadata-features-auto-lock-time-config`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether a TTLock device supports auto-lock time configuration.`})}),_jsx(ResponseField,{name:`incomplete_keyboard_passcode`,id:`device-properties-ttlock-metadata-features-incomplete-keyboard-passcode`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether a TTLock device supports an incomplete keyboard passcode.`})}),_jsx(ResponseField,{name:`lock_command`,id:`device-properties-ttlock-metadata-features-lock-command`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether a TTLock device supports the lock command.`})}),_jsx(ResponseField,{name:`passcode`,id:`device-properties-ttlock-metadata-features-passcode`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether a TTLock device supports a passcode.`})}),_jsx(ResponseField,{name:`passcode_management`,id:`device-properties-ttlock-metadata-features-passcode-management`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether a TTLock device supports passcode management.`})}),_jsx(ResponseField,{name:`unlock_via_gateway`,id:`device-properties-ttlock-metadata-features-unlock-via-gateway`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether a TTLock device supports unlock via gateway.`})}),_jsx(ResponseField,{name:`wifi`,id:`device-properties-ttlock-metadata-features-wifi`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether a TTLock device supports Wi-Fi.`})})]})]}),_jsx(ResponseField,{name:`has_gateway`,id:`device-properties-ttlock-metadata-has-gateway`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates whether a TTLock device has a gateway.`})}),_jsx(ResponseField,{name:`lock_alias`,id:`device-properties-ttlock-metadata-lock-alias`,type:`String`,children:_jsx(_components.p,{children:`Lock alias for a TTLock device.`})}),_jsx(ResponseField,{name:`lock_id`,id:`device-properties-ttlock-metadata-lock-id`,type:`Number`,children:_jsx(_components.p,{children:`Lock ID for a TTLock device.`})}),_jsx(ResponseField,{name:`timezone_raw_offset_ms`,id:`device-properties-ttlock-metadata-timezone-raw-offset-ms`,type:`Number or null`,children:_jsx(_components.p,{children:`Lock-side timezone offset in milliseconds east of UTC, as configured in the TTLock app. Source of truth for the lock’s wall-clock interpretation of access code start/end times — a misconfigured value here is the typical cause of customer “codes offset by N hours” reports. Diagnostic only; Seam does not convert times based on this value.`})}),_jsxs(ResponseField,{name:`wireless_keypads`,id:`device-properties-ttlock-metadata-wireless-keypads`,type:`Array of Objects`,children:[_jsx(_components.p,{children:`Wireless keypads for a TTLock device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`wireless_keypad_id`,id:`device-properties-ttlock-metadata-wireless-keypads-wireless-keypad-id`,type:`Number`,children:_jsx(_components.p,{children:`ID for a wireless keypad for a TTLock device.`})}),_jsx(ResponseField,{name:`wireless_keypad_name`,id:`device-properties-ttlock-metadata-wireless-keypads-wireless-keypad-name`,type:`String`,children:_jsx(_components.p,{children:`Name for a wireless keypad for a TTLock device.`})})]})]})]})]}),`\n`,_jsxs(ResponseField,{name:`tuya_metadata`,id:`device-properties-tuya-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Tuya device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`category`,id:`device-properties-tuya-metadata-category`,type:`String`,children:_jsx(_components.p,{children:`Tuya product category code for the device (e.g. ms).`})}),_jsx(ResponseField,{name:`device_id`,id:`device-properties-tuya-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a Tuya device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-tuya-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Tuya device.`})}),_jsx(ResponseField,{name:`model`,id:`device-properties-tuya-metadata-model`,type:`String or null`,children:_jsx(_components.p,{children:`Model reported for a Tuya device.`})}),_jsx(ResponseField,{name:`product_id`,id:`device-properties-tuya-metadata-product-id`,type:`String`,children:_jsx(_components.p,{children:`Tuya product ID for the device.`})}),_jsx(ResponseField,{name:`product_name`,id:`device-properties-tuya-metadata-product-name`,type:`String`,children:_jsx(_components.p,{children:`Tuya product name for the device.`})}),_jsx(ResponseField,{name:`time_zone`,id:`device-properties-tuya-metadata-time-zone`,type:`String or null`,children:_jsx(_components.p,{children:`Time zone reported for a Tuya device (e.g. +08:00).`})})]})]}),`\n`,_jsxs(ResponseField,{name:`two_n_metadata`,id:`device-properties-two-n-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a 2N device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-two-n-metadata-device-id`,type:`Number`,children:_jsx(_components.p,{children:`Device ID for a 2N device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-two-n-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a 2N device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`ultraloq_metadata`,id:`device-properties-ultraloq-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for an Ultraloq device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-ultraloq-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for an Ultraloq device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-ultraloq-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for an Ultraloq device.`})}),_jsx(ResponseField,{name:`device_type`,id:`device-properties-ultraloq-metadata-device-type`,type:`String`,children:_jsx(_components.p,{children:`Device type for an Ultraloq device.`})}),_jsx(ResponseField,{name:`time_zone`,id:`device-properties-ultraloq-metadata-time-zone`,type:`String or null`,children:_jsx(_components.p,{children:`IANA timezone for the Ultraloq device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`unifi_protect_metadata`,id:`device-properties-unifi-protect-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a UniFi Protect camera.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`camera_id`,id:`device-properties-unifi-protect-metadata-camera-id`,type:`String`,children:_jsx(_components.p,{children:`Camera ID reported by UniFi Protect.`})}),_jsx(ResponseField,{name:`camera_name`,id:`device-properties-unifi-protect-metadata-camera-name`,type:`String`,children:_jsx(_components.p,{children:`Camera name reported by UniFi Protect.`})}),_jsx(ResponseField,{name:`has_mic`,id:`device-properties-unifi-protect-metadata-has-mic`,type:`Boolean`,children:_jsx(_components.p,{children:`Whether the camera has a microphone.`})}),_jsx(ResponseField,{name:`mac`,id:`device-properties-unifi-protect-metadata-mac`,type:`String`,children:_jsx(_components.p,{children:`MAC address reported by the UniFi Protect camera.`})}),_jsx(ResponseField,{name:`model`,id:`device-properties-unifi-protect-metadata-model`,type:`String`,children:_jsx(_components.p,{children:`Model reported by the UniFi Protect camera.`})}),_jsx(ResponseField,{name:`nvr_name`,id:`device-properties-unifi-protect-metadata-nvr-name`,type:`String`,children:_jsx(_components.p,{children:`Name of the UniFi Protect console that manages the camera.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`visionline_metadata`,id:`device-properties-visionline-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for an ASSA ABLOY Visionline system.`}),_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`encoder_id`,id:`device-properties-visionline-metadata-encoder-id`,type:`String`,children:_jsx(_components.p,{children:`Encoder ID for an ASSA ABLOY Visionline system.`})})})]}),`\n`,_jsxs(ResponseField,{name:`wyze_metadata`,id:`device-properties-wyze-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Wyze device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-wyze-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a Wyze device.`})}),_jsx(ResponseField,{name:`device_info_model`,id:`device-properties-wyze-metadata-device-info-model`,type:`String`,children:_jsx(_components.p,{children:`Device information model for a Wyze device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-wyze-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Wyze device.`})}),_jsx(ResponseField,{name:`keypad_uuid`,id:`device-properties-wyze-metadata-keypad-uuid`,type:`String`,children:_jsx(_components.p,{children:`Keypad UUID for a Wyze device.`})}),_jsx(ResponseField,{name:`locker_status_hardlock`,id:`device-properties-wyze-metadata-locker-status-hardlock`,type:`Number`,children:_jsx(_components.p,{children:`Locker status (hardlock) for a Wyze device.`})}),_jsx(ResponseField,{name:`product_model`,id:`device-properties-wyze-metadata-product-model`,type:`String`,children:_jsx(_components.p,{children:`Product model for a Wyze device.`})}),_jsx(ResponseField,{name:`product_name`,id:`device-properties-wyze-metadata-product-name`,type:`String`,children:_jsx(_components.p,{children:`Product name for a Wyze device.`})}),_jsx(ResponseField,{name:`product_type`,id:`device-properties-wyze-metadata-product-type`,type:`String`,children:_jsx(_components.p,{children:`Product type for a Wyze device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`yacan_metadata`,id:`device-properties-yacan-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Yacan device.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-yacan-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a Yacan device.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-yacan-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Yacan device.`})}),_jsx(ResponseField,{name:`device_type`,id:`device-properties-yacan-metadata-device-type`,type:`String`,children:_jsx(_components.p,{children:`Device type for a Yacan device.`})}),_jsx(ResponseField,{name:`serial_number`,id:`device-properties-yacan-metadata-serial-number`,type:`String`,children:_jsx(_components.p,{children:`Serial number for a Yacan device.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`yale_connect_metadata`,id:`device-properties-yale-connect-metadata`,type:`Object`,children:[_jsx(_components.p,{children:`Metadata for a Yale Connect lock.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`device_id`,id:`device-properties-yale-connect-metadata-device-id`,type:`String`,children:_jsx(_components.p,{children:`Device ID for a Yale Connect lock.`})}),_jsx(ResponseField,{name:`device_name`,id:`device-properties-yale-connect-metadata-device-name`,type:`String`,children:_jsx(_components.p,{children:`Device name for a Yale Connect lock.`})}),_jsx(ResponseField,{name:`firmware_version`,id:`device-properties-yale-connect-metadata-firmware-version`,type:`String`,children:_jsx(_components.p,{children:`Firmware version reported by the Yale Connect lock.`})}),_jsx(ResponseField,{name:`home_name`,id:`device-properties-yale-connect-metadata-home-name`,type:`String`,children:_jsx(_components.p,{children:`Name of the Yale Connect home that contains the lock.`})}),_jsx(ResponseField,{name:`model`,id:`device-properties-yale-connect-metadata-model`,type:`String`,children:_jsx(_components.p,{children:`Model reported by the Yale Connect lock.`})}),_jsx(ResponseField,{name:`time_zone_description`,id:`device-properties-yale-connect-metadata-time-zone-description`,type:`String`,children:_jsx(_components.p,{children:`Time zone of the Yale Connect home, as Yale reports it.`})})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Common Device Properties","description":"Reference shared device properties and provider metadata for Seam devices, including smart locks, thermostats, sensors, and connected hardware.","href":"/api/devices/properties"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Shared Device Properties","slug":"shared-device-properties","depth":2,"children":[]},{"title":"Properties","slug":"properties","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/seam/4d860677184e9142/pylon.js","/docs/_mintlify/custom/seam/18bfb52c609a48d7/custom.js"],"subdomain":"seam","siteName":"Seam","title":"Common Device Properties - Seam","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T23:27:02.245Z","originalFileLocation":"api/devices/properties.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Reference shared device properties and provider metadata for Seam devices, including smart locks, thermostats, sensors, and connected hardware.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Seam\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/seam/8CXnKXKCxYx4_wys/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/seam/8CXnKXKCxYx4_wys/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/seam/8CXnKXKCxYx4_wys/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/seam/8CXnKXKCxYx4_wys/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/seam/8CXnKXKCxYx4_wys/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/seam/8CXnKXKCxYx4_wys/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/seam/8CXnKXKCxYx4_wys/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/seam/8CXnKXKCxYx4_wys/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/seam/8CXnKXKCxYx4_wys/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Common Device Properties - Seam\">\u003cmeta data-mint-head property=\"og:description\" content=\"Reference shared device properties and provider metadata for Seam devices, including smart locks, thermostats, sensors, and connected hardware.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Seam\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.seam.co/docs/api/devices/properties\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://www.seam.co/docs/images/seam-og-default.jpg\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Common Device Properties - Seam\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Reference shared device properties and provider metadata for Seam devices, including smart locks, thermostats, sensors, and connected hardware.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://www.seam.co/docs/images/seam-og-default.jpg\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/seam/8CXnKXKCxYx4_wys/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Seam\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4C45D9\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.seam.co/docs/api/devices/properties\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api/devices/properties.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.seam.co/#organization\",\"name\":\"Seam\",\"url\":\"https://www.seam.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/seam/RVHI-5qT0fl5Zkft/images/seam-logo-light.svg?fit=max\u0026auto=format\u0026n=RVHI-5qT0fl5Zkft\u0026q=85\u0026s=4529d092246aab7709a6692a7cdccf39\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.seam.co/docs#website\",\"name\":\"Seam\",\"url\":\"https://www.seam.co/docs\",\"publisher\":{\"@id\":\"https://www.seam.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.seam.co/docs/api/devices/properties#webpage\",\"url\":\"https://www.seam.co/docs/api/devices/properties\",\"name\":\"Common Device Properties\",\"description\":\"Reference shared device properties and provider metadata for Seam devices, including smart locks, thermostats, sensors, and connected hardware.\",\"dateModified\":\"2026-11-19T23:27:02.245Z\",\"isPartOf\":{\"@id\":\"https://www.seam.co/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.seam.co/docs/api/devices/properties#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.seam.co/docs/api/devices/properties#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Devices and Systems\",\"item\":\"https://www.seam.co/docs/api/devices/object\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Devices\",\"item\":\"https://www.seam.co/docs/api/devices/object\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Common Device Properties\",\"item\":\"https://www.seam.co/docs/api/devices/properties\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://www.seam.co/docs/api/devices/properties#article\",\"headline\":\"Common Device Properties\",\"name\":\"Common Device Properties\",\"description\":\"Reference shared device properties and provider metadata for Seam devices, including smart locks, thermostats, sensors, and connected hardware.\",\"url\":\"https://www.seam.co/docs/api/devices/properties\",\"mainEntityOfPage\":{\"@id\":\"https://www.seam.co/docs/api/devices/properties#webpage\"},\"image\":\"https://www.seam.co/docs/images/seam-og-default.jpg\",\"dateModified\":\"2026-11-19T23:27:02.245Z\",\"publisher\":{\"@id\":\"https://www.seam.co/#organization\"},\"isPartOf\":{\"@id\":\"https://www.seam.co/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Seam\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Seam\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api/devices/properties.md","siteName":"Seam","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api"},{"title":"SDK Installation","href":"/api/installation"},{"title":"MCP Installation","href":"/api/mcp-installation"},{"title":"Authentication","href":"/api/authentication"},{"title":"Pagination","href":"/api/pagination"},{"title":"Rate Limits and Guardrails","href":"/api/rate-limits-and-guardrails"},{"title":"End-of-Life APIs","href":"/api/end-of-life"}]},{"group":"Granting Access","pages":[{"group":"Access Grants","pages":[{"title":"The Access Grant Object","href":"/api/access_grants/object"},{"title":"Access Grant Events","href":"/api/access_grants/events"},{"title":"Access Grant Errors and Warnings","href":"/api/access_grants/errors"},{"title":"Get an Access Grant","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /access_grants/get","href":"/api/access_grants/get"},{"title":"List Access Grants","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /access_grants/list","href":"/api/access_grants/list"},{"title":"Create an Access Grant","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /access_grants/create","href":"/api/access_grants/create"},{"title":"Delete an Access Grant","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /access_grants/delete","href":"/api/access_grants/delete"},{"title":"Update an Access Grant","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /access_grants/update","href":"/api/access_grants/update"},{"title":"Get related Access Grant resources","deprecated":null,"version":null,"sidebarTitle":"Get related","openapi":"/openapi.json get /access_grants/get_related","href":"/api/access_grants/get_related"},{"title":"Add Requested Access Methods to Access Grant","deprecated":null,"version":null,"sidebarTitle":"Request access methods","openapi":"/openapi.json post /access_grants/request_access_methods","href":"/api/access_grants/request_access_methods"},{"group":"Unmanaged","pages":[{"title":"Unmanaged","href":"/api/access_grants/unmanaged/object"},{"title":"Unmanaged Errors and Warnings","href":"/api/access_grants/unmanaged/errors"},{"title":"Get an Unmanaged Access Grant","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /access_grants/unmanaged/get","href":"/api/access_grants/unmanaged/get"},{"title":"List Unmanaged Access Grants","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /access_grants/unmanaged/list","href":"/api/access_grants/unmanaged/list"},{"title":"Update an Unmanaged Access Grant","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /access_grants/unmanaged/update","href":"/api/access_grants/unmanaged/update"}]}]},{"group":"Access Methods","pages":[{"title":"The Access Method Object","href":"/api/access_methods/object"},{"title":"Access Method Events","href":"/api/access_methods/events"},{"title":"Access Method Errors and Warnings","href":"/api/access_methods/errors"},{"title":"Get an Access Method","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /access_methods/get","href":"/api/access_methods/get"},{"title":"List Access Methods","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /access_methods/list","href":"/api/access_methods/list"},{"title":"Delete an Access Method","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /access_methods/delete","href":"/api/access_methods/delete"},{"title":"Assign a Card Credential to an Access Method","deprecated":null,"version":null,"sidebarTitle":"Assign card","openapi":"/openapi.json post /access_methods/assign_card","href":"/api/access_methods/assign_card"},{"title":"Encode an Access Method","deprecated":null,"version":null,"sidebarTitle":"Encode","openapi":"/openapi.json post /access_methods/encode","href":"/api/access_methods/encode"},{"title":"Get related Access Method resources","deprecated":null,"version":null,"sidebarTitle":"Get related","openapi":"/openapi.json get /access_methods/get_related","href":"/api/access_methods/get_related"},{"title":"Unlock a Door with an Access Method","deprecated":null,"version":null,"sidebarTitle":"Unlock door","openapi":"/openapi.json post /access_methods/unlock_door","href":"/api/access_methods/unlock_door"},{"group":"Unmanaged","pages":[{"title":"Unmanaged","href":"/api/access_methods/unmanaged/object"},{"title":"Unmanaged Errors and Warnings","href":"/api/access_methods/unmanaged/errors"},{"title":"Get an Unmanaged Access Method","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /access_methods/unmanaged/get","href":"/api/access_methods/unmanaged/get"},{"title":"List Unmanaged Access Methods","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /access_methods/unmanaged/list","href":"/api/access_methods/unmanaged/list"}]}]}]},{"group":"Devices and Systems","pages":[{"group":"Devices","pages":[{"title":"The Device Object","description":"Learn how the device object represents a smart lock, thermostat, sensor, or other device connected to Seam, including its properties and events.","href":"/api/devices/object"},{"title":"Common Device Properties","href":"/api/devices/properties"},{"title":"Device Examples","description":"Explore complete Seam device object examples for smart locks, noise sensors, and thermostats, including properties, capabilities, and provider metadata.","href":"/api/devices/examples"},{"title":"Device Events","href":"/api/devices/events"},{"title":"Device Errors and Warnings","href":"/api/devices/errors"},{"title":"Get a Device","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /devices/get","href":"/api/devices/get"},{"title":"List Devices","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /devices/list","href":"/api/devices/list"},{"title":"Update a Device","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /devices/update","href":"/api/devices/update"},{"title":"List Device Providers","deprecated":null,"version":null,"sidebarTitle":"List device providers","openapi":"/openapi.json get /devices/list_device_providers","href":"/api/devices/list_device_providers"},{"title":"Report Provider Metadata","deprecated":null,"version":null,"sidebarTitle":"Report provider metadata","openapi":"/openapi.json post /devices/report_provider_metadata","href":"/api/devices/report_provider_metadata"},{"group":"Simulations","pages":[{"title":"Device Simulations","href":"/api/devices/simulate/object"},{"title":"Simulate Device Connection","deprecated":null,"version":null,"sidebarTitle":"Connect","openapi":"/openapi.json post /devices/simulate/connect","href":"/api/devices/simulate/connect"},{"title":"Simulate Hub Connection","deprecated":null,"version":null,"sidebarTitle":"Connect to hub","openapi":"/openapi.json post /devices/simulate/connect_to_hub","href":"/api/devices/simulate/connect_to_hub"},{"title":"Simulate Device Disconnection","deprecated":null,"version":null,"sidebarTitle":"Disconnect","openapi":"/openapi.json post /devices/simulate/disconnect","href":"/api/devices/simulate/disconnect"},{"title":"Simulate Hub Disconnection","deprecated":null,"version":null,"sidebarTitle":"Disconnect from hub","openapi":"/openapi.json post /devices/simulate/disconnect_from_hub","href":"/api/devices/simulate/disconnect_from_hub"},{"title":"Simulate Paid Subscription","deprecated":null,"version":null,"sidebarTitle":"Paid subscription","openapi":"/openapi.json post /devices/simulate/paid_subscription","href":"/api/devices/simulate/paid_subscription"},{"title":"Simulate Device Removal","deprecated":null,"version":null,"sidebarTitle":"Remove","openapi":"/openapi.json post /devices/simulate/remove","href":"/api/devices/simulate/remove"}]},{"group":"Unmanaged Devices","pages":[{"title":"Unmanaged Devices","href":"/api/devices/unmanaged/object"},{"title":"Unmanaged Devices Events","href":"/api/devices/unmanaged/events"},{"title":"Unmanaged Devices Errors and Warnings","href":"/api/devices/unmanaged/errors"},{"title":"Get an Unmanaged Device","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /devices/unmanaged/get","href":"/api/devices/unmanaged/get"},{"title":"List Unmanaged Devices","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /devices/unmanaged/list","href":"/api/devices/unmanaged/list"},{"title":"Update an Unmanaged Device","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /devices/unmanaged/update","href":"/api/devices/unmanaged/update"}]}]},{"group":"Locks","pages":[{"title":"The Lock Object","href":"/api/locks/object"},{"title":"Lock Events","href":"/api/locks/events"},{"title":"Lock Errors and Warnings","href":"/api/locks/errors"},{"title":"Get a Lock","deprecated":true,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /locks/get","href":"/api/locks/get"},{"title":"List Locks","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /locks/list","href":"/api/locks/list"},{"title":"Configure Auto-Lock","deprecated":null,"version":null,"sidebarTitle":"Configure auto lock","openapi":"/openapi.json post /locks/configure_auto_lock","href":"/api/locks/configure_auto_lock"},{"title":"Lock a Lock","deprecated":null,"version":null,"sidebarTitle":"Lock door","openapi":"/openapi.json post /locks/lock_door","href":"/api/locks/lock_door"},{"title":"Unlock a Lock","deprecated":null,"version":null,"sidebarTitle":"Unlock door","openapi":"/openapi.json post /locks/unlock_door","href":"/api/locks/unlock_door"},{"group":"Simulations","pages":[{"title":"Lock Simulations","href":"/api/locks/simulate/object"},{"title":"Simulate a Keypad Code Entry","deprecated":null,"version":null,"sidebarTitle":"Keypad code entry","openapi":"/openapi.json post /locks/simulate/keypad_code_entry","href":"/api/locks/simulate/keypad_code_entry"},{"title":"Simulate a Manual Lock Action Using a Keypad","deprecated":null,"version":null,"sidebarTitle":"Manual lock via keypad","openapi":"/openapi.json post /locks/simulate/manual_lock_via_keypad","href":"/api/locks/simulate/manual_lock_via_keypad"}]}]},{"group":"Thermostats","pages":[{"title":"The Thermostat Object","href":"/api/thermostats/object"},{"title":"Thermostat Events","href":"/api/thermostats/events"},{"title":"Thermostat Errors and Warnings","href":"/api/thermostats/errors"},{"title":"List Thermostats","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /thermostats/list","href":"/api/thermostats/list"},{"title":"Activate a Climate Preset","deprecated":null,"version":null,"sidebarTitle":"Activate climate preset","openapi":"/openapi.json post /thermostats/activate_climate_preset","href":"/api/thermostats/activate_climate_preset"},{"title":"Activate the Weekly Program","deprecated":null,"version":null,"sidebarTitle":"Activate weekly program","openapi":"/openapi.json post /thermostats/activate_weekly_program","href":"/api/thermostats/activate_weekly_program"},{"title":"Set to Cool Mode","deprecated":null,"version":null,"sidebarTitle":"Cool","openapi":"/openapi.json post /thermostats/cool","href":"/api/thermostats/cool"},{"title":"Create a Climate Preset","deprecated":null,"version":null,"sidebarTitle":"Create climate preset","openapi":"/openapi.json post /thermostats/create_climate_preset","href":"/api/thermostats/create_climate_preset"},{"title":"Delete a Climate Preset","deprecated":null,"version":null,"sidebarTitle":"Delete climate preset","openapi":"/openapi.json delete /thermostats/delete_climate_preset","href":"/api/thermostats/delete_climate_preset"},{"title":"Set to Heat Mode","deprecated":null,"version":null,"sidebarTitle":"Heat","openapi":"/openapi.json post /thermostats/heat","href":"/api/thermostats/heat"},{"title":"Set to Heat-Cool (Auto) Mode","deprecated":null,"version":null,"sidebarTitle":"Heat cool","openapi":"/openapi.json post /thermostats/heat_cool","href":"/api/thermostats/heat_cool"},{"title":"Set to Off Mode","deprecated":null,"version":null,"sidebarTitle":"Off","openapi":"/openapi.json post /thermostats/off","href":"/api/thermostats/off"},{"title":"Set the Fallback Climate Preset","deprecated":null,"version":null,"sidebarTitle":"Set fallback climate preset","openapi":"/openapi.json post /thermostats/set_fallback_climate_preset","href":"/api/thermostats/set_fallback_climate_preset"},{"title":"Set the Fan Mode Setting","deprecated":null,"version":null,"sidebarTitle":"Set fan mode","openapi":"/openapi.json post /thermostats/set_fan_mode","href":"/api/thermostats/set_fan_mode"},{"title":"Set the HVAC Mode","deprecated":null,"version":null,"sidebarTitle":"Set hvac mode","openapi":"/openapi.json post /thermostats/set_hvac_mode","href":"/api/thermostats/set_hvac_mode"},{"title":"Set a Temperature Threshold","deprecated":null,"version":null,"sidebarTitle":"Set temperature threshold","openapi":"/openapi.json patch /thermostats/set_temperature_threshold","href":"/api/thermostats/set_temperature_threshold"},{"title":"Update a Climate Preset","deprecated":null,"version":null,"sidebarTitle":"Update climate preset","openapi":"/openapi.json patch /thermostats/update_climate_preset","href":"/api/thermostats/update_climate_preset"},{"title":"Update the Thermostat Weekly Program","deprecated":null,"version":null,"sidebarTitle":"Update weekly program","openapi":"/openapi.json post /thermostats/update_weekly_program","href":"/api/thermostats/update_weekly_program"},{"group":"Daily Programs","pages":[{"title":"Daily Programs","href":"/api/thermostats/daily_programs/object"},{"title":"Create a Thermostat Daily Program","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /thermostats/daily_programs/create","href":"/api/thermostats/daily_programs/create"},{"title":"Delete a Thermostat Daily Program","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /thermostats/daily_programs/delete","href":"/api/thermostats/daily_programs/delete"},{"title":"Update a Thermostat Daily Program","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /thermostats/daily_programs/update","href":"/api/thermostats/daily_programs/update"}]},{"group":"Schedules","pages":[{"title":"Thermostat Schedules","href":"/api/thermostats/schedules/object"},{"title":"Get a Thermostat Schedule","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /thermostats/schedules/get","href":"/api/thermostats/schedules/get"},{"title":"List Thermostat Schedules","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /thermostats/schedules/list","href":"/api/thermostats/schedules/list"},{"title":"Create a Thermostat Schedule","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /thermostats/schedules/create","href":"/api/thermostats/schedules/create"},{"title":"Delete a Thermostat Schedule","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /thermostats/schedules/delete","href":"/api/thermostats/schedules/delete"},{"title":"Update a Thermostat Schedule","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /thermostats/schedules/update","href":"/api/thermostats/schedules/update"}]},{"group":"Simulations","pages":[{"title":"Thermostat Simulations","href":"/api/thermostats/simulate/object"},{"title":"HVAC Mode Adjusted","deprecated":null,"version":null,"sidebarTitle":"Hvac mode adjusted","openapi":"/openapi.json post /thermostats/simulate/hvac_mode_adjusted","href":"/api/thermostats/simulate/hvac_mode_adjusted"},{"title":"Temperature Reached","deprecated":null,"version":null,"sidebarTitle":"Temperature reached","openapi":"/openapi.json post /thermostats/simulate/temperature_reached","href":"/api/thermostats/simulate/temperature_reached"}]}]},{"group":"Noise Sensors","pages":[{"title":"The Noise Sensor Object","href":"/api/noise_sensors/object"},{"title":"List Noise Sensors","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /noise_sensors/list","href":"/api/noise_sensors/list"},{"group":"Simulations","pages":[{"title":"Noise Sensor Simulations","href":"/api/noise_sensors/simulate/object"},{"title":"Simulate Triggering a Noise Threshold","deprecated":null,"version":null,"sidebarTitle":"Trigger noise threshold","openapi":"/openapi.json post /noise_sensors/simulate/trigger_noise_threshold","href":"/api/noise_sensors/simulate/trigger_noise_threshold"}]},{"group":"Noise Thresholds","pages":[{"title":"Noise Thresholds","href":"/api/noise_sensors/noise_thresholds/object"},{"title":"Noise Thresholds Events","href":"/api/noise_sensors/noise_thresholds/events"},{"title":"Get a Noise Threshold","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /noise_sensors/noise_thresholds/get","href":"/api/noise_sensors/noise_thresholds/get"},{"title":"List Noise Thresholds","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /noise_sensors/noise_thresholds/list","href":"/api/noise_sensors/noise_thresholds/list"},{"title":"Create a Noise Threshold","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /noise_sensors/noise_thresholds/create","href":"/api/noise_sensors/noise_thresholds/create"},{"title":"Delete a Noise Threshold","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /noise_sensors/noise_thresholds/delete","href":"/api/noise_sensors/noise_thresholds/delete"},{"title":"Update a Noise Threshold","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /noise_sensors/noise_thresholds/update","href":"/api/noise_sensors/noise_thresholds/update"}]}]},{"group":"Cameras","pages":[{"title":"Camera Live Views","href":"/api/cameras/live_views/object"},{"title":"Create a Camera Live View Session","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /cameras/live_views/create","href":"/api/cameras/live_views/create"},{"title":"Negotiate a Camera Live View","deprecated":null,"version":null,"sidebarTitle":"Offer","openapi":"/openapi.json post /cameras/live_views/offer","href":"/api/cameras/live_views/offer"},{"title":"Stop a Camera Live View Session","deprecated":null,"version":null,"sidebarTitle":"Stop","openapi":"/openapi.json post /cameras/live_views/stop","href":"/api/cameras/live_views/stop"}]},{"group":"Access Control Systems (ACS)","pages":[{"title":"Access Control Systems","href":"/api/acs/object"},{"group":"Access Groups","pages":[{"title":"The Access Group Object","href":"/api/acs/access_groups/object"},{"title":"Access Group Events","href":"/api/acs/access_groups/events"},{"title":"Access Group Errors","href":"/api/acs/access_groups/errors"},{"title":"Get an Access Group","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /acs/access_groups/get","href":"/api/acs/access_groups/get"},{"title":"List Access Groups","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /acs/access_groups/list","href":"/api/acs/access_groups/list"},{"title":"Delete an Access Group","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /acs/access_groups/delete","href":"/api/acs/access_groups/delete"},{"title":"Add an ACS User to an Access Group","deprecated":null,"version":null,"sidebarTitle":"Add user","openapi":"/openapi.json put /acs/access_groups/add_user","href":"/api/acs/access_groups/add_user"},{"title":"List Entrances Accessible to an Access Group","deprecated":null,"version":null,"sidebarTitle":"List accessible entrances","openapi":"/openapi.json get /acs/access_groups/list_accessible_entrances","href":"/api/acs/access_groups/list_accessible_entrances"},{"title":"List ACS Users in an Access Group","deprecated":null,"version":null,"sidebarTitle":"List users","openapi":"/openapi.json get /acs/access_groups/list_users","href":"/api/acs/access_groups/list_users"},{"title":"Remove an ACS User from an Access Group","deprecated":null,"version":null,"sidebarTitle":"Remove user","openapi":"/openapi.json delete /acs/access_groups/remove_user","href":"/api/acs/access_groups/remove_user"}]},{"group":"ACS Users","pages":[{"title":"The ACS User Object","href":"/api/acs/users/object"},{"title":"ACS User Events","href":"/api/acs/users/events"},{"title":"ACS User Errors and Warnings","href":"/api/acs/users/errors"},{"title":"Get an ACS User","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /acs/users/get","href":"/api/acs/users/get"},{"title":"List ACS Users","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /acs/users/list","href":"/api/acs/users/list"},{"title":"Create an ACS User","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /acs/users/create","href":"/api/acs/users/create"},{"title":"Delete an ACS User","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /acs/users/delete","href":"/api/acs/users/delete"},{"title":"Update an ACS User","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /acs/users/update","href":"/api/acs/users/update"},{"title":"Add an ACS User to an Access Group","deprecated":null,"version":null,"sidebarTitle":"Add to access group","openapi":"/openapi.json put /acs/users/add_to_access_group","href":"/api/acs/users/add_to_access_group"},{"title":"List ACS User-Accessible Entrances","deprecated":null,"version":null,"sidebarTitle":"List accessible entrances","openapi":"/openapi.json get /acs/users/list_accessible_entrances","href":"/api/acs/users/list_accessible_entrances"},{"title":"Remove an ACS User from an Access Group","deprecated":null,"version":null,"sidebarTitle":"Remove from access group","openapi":"/openapi.json delete /acs/users/remove_from_access_group","href":"/api/acs/users/remove_from_access_group"},{"title":"Revoke ACS User Access to All Entrances","deprecated":null,"version":null,"sidebarTitle":"Revoke access to all entrances","openapi":"/openapi.json post /acs/users/revoke_access_to_all_entrances","href":"/api/acs/users/revoke_access_to_all_entrances"},{"title":"Suspend an ACS User","deprecated":null,"version":null,"sidebarTitle":"Suspend","openapi":"/openapi.json post /acs/users/suspend","href":"/api/acs/users/suspend"},{"title":"Unsuspend an ACS User","deprecated":null,"version":null,"sidebarTitle":"Unsuspend","openapi":"/openapi.json post /acs/users/unsuspend","href":"/api/acs/users/unsuspend"}]},{"group":"Credentials","pages":[{"title":"The Credential Object","href":"/api/acs/credentials/object"},{"title":"Credential Events","href":"/api/acs/credentials/events"},{"title":"Credential Warnings","href":"/api/acs/credentials/errors"},{"title":"Get a Credential","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /acs/credentials/get","href":"/api/acs/credentials/get"},{"title":"List Credentials","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /acs/credentials/list","href":"/api/acs/credentials/list"},{"title":"Create a Credential for an ACS User","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /acs/credentials/create","href":"/api/acs/credentials/create"},{"title":"Delete a Credential","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /acs/credentials/delete","href":"/api/acs/credentials/delete"},{"title":"Update a Credential","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /acs/credentials/update","href":"/api/acs/credentials/update"},{"title":"Assign a Credential to an ACS User","deprecated":null,"version":null,"sidebarTitle":"Assign","openapi":"/openapi.json patch /acs/credentials/assign","href":"/api/acs/credentials/assign"},{"title":"List Accessible Entrances","deprecated":null,"version":null,"sidebarTitle":"List accessible entrances","openapi":"/openapi.json get /acs/credentials/list_accessible_entrances","href":"/api/acs/credentials/list_accessible_entrances"},{"title":"Unassign a Credential from an ACS User","deprecated":null,"version":null,"sidebarTitle":"Unassign","openapi":"/openapi.json patch /acs/credentials/unassign","href":"/api/acs/credentials/unassign"}]},{"group":"Encoders","pages":[{"title":"The Encoder Object","href":"/api/acs/encoders/object"},{"title":"Encoder Events","href":"/api/acs/encoders/events"},{"title":"Get an Encoder","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /acs/encoders/get","href":"/api/acs/encoders/get"},{"title":"List Encoders","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /acs/encoders/list","href":"/api/acs/encoders/list"},{"title":"Encode a Credential","deprecated":null,"version":null,"sidebarTitle":"Encode credential","openapi":"/openapi.json post /acs/encoders/encode_credential","href":"/api/acs/encoders/encode_credential"},{"title":"Scan a Credential","deprecated":null,"version":null,"sidebarTitle":"Scan credential","openapi":"/openapi.json post /acs/encoders/scan_credential","href":"/api/acs/encoders/scan_credential"},{"title":"Scan to Assign a Credential","deprecated":null,"version":null,"sidebarTitle":"Scan to assign credential","openapi":"/openapi.json post /acs/encoders/scan_to_assign_credential","href":"/api/acs/encoders/scan_to_assign_credential"},{"group":"Simulations","pages":[{"title":"Encoder Simulations","href":"/api/acs/encoders/simulate/object"},{"title":"Simulate that the Next Credential Encoding Will Fail","deprecated":null,"version":null,"sidebarTitle":"Next credential encode will fail","openapi":"/openapi.json post /acs/encoders/simulate/next_credential_encode_will_fail","href":"/api/acs/encoders/simulate/next_credential_encode_will_fail"},{"title":"Simulate that the Next Credential Encoding Will Succeed","deprecated":null,"version":null,"sidebarTitle":"Next credential encode will succeed","openapi":"/openapi.json post /acs/encoders/simulate/next_credential_encode_will_succeed","href":"/api/acs/encoders/simulate/next_credential_encode_will_succeed"},{"title":"Simulate that the Next Credential Scan Will Fail","deprecated":null,"version":null,"sidebarTitle":"Next credential scan will fail","openapi":"/openapi.json post /acs/encoders/simulate/next_credential_scan_will_fail","href":"/api/acs/encoders/simulate/next_credential_scan_will_fail"},{"title":"Simulate that the Next Credential Scan Will Succeed","deprecated":null,"version":null,"sidebarTitle":"Next credential scan will succeed","openapi":"/openapi.json post /acs/encoders/simulate/next_credential_scan_will_succeed","href":"/api/acs/encoders/simulate/next_credential_scan_will_succeed"}]}]},{"group":"Entrances","pages":[{"title":"The Entrance Object","href":"/api/acs/entrances/object"},{"title":"Entrance Events","href":"/api/acs/entrances/events"},{"title":"Entrance Errors and Warnings","href":"/api/acs/entrances/errors"},{"title":"Get an Entrance","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /acs/entrances/get","href":"/api/acs/entrances/get"},{"title":"List Entrances","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /acs/entrances/list","href":"/api/acs/entrances/list"},{"title":"Grant an ACS User Access to an Entrance","deprecated":null,"version":null,"sidebarTitle":"Grant access","openapi":"/openapi.json post /acs/entrances/grant_access","href":"/api/acs/entrances/grant_access"},{"title":"List Credentials with Access to an Entrance","deprecated":null,"version":null,"sidebarTitle":"List credentials with access","openapi":"/openapi.json get /acs/entrances/list_credentials_with_access","href":"/api/acs/entrances/list_credentials_with_access"},{"title":"Unlock an Entrance","deprecated":null,"version":null,"sidebarTitle":"Unlock","openapi":"/openapi.json post /acs/entrances/unlock","href":"/api/acs/entrances/unlock"}]},{"group":"Systems","pages":[{"title":"The ACS System Object","href":"/api/acs/systems/object"},{"title":"ACS System Events","href":"/api/acs/systems/events"},{"title":"ACS System Errors and Warnings","href":"/api/acs/systems/errors"},{"title":"Get an ACS System","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /acs/systems/get","href":"/api/acs/systems/get"},{"title":"List ACS Systems","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /acs/systems/list","href":"/api/acs/systems/list"},{"title":"List Compatible Credential Manager ACS Systems","deprecated":null,"version":null,"sidebarTitle":"List compatible credential manager acs systems","openapi":"/openapi.json get /acs/systems/list_compatible_credential_manager_acs_systems","href":"/api/acs/systems/list_compatible_credential_manager_acs_systems"},{"title":"Report Devices","deprecated":null,"version":null,"sidebarTitle":"Report devices","openapi":"/openapi.json post /acs/systems/report_devices","href":"/api/acs/systems/report_devices"}]}]}]},{"group":"Setup","pages":[{"group":"Connect Webviews","pages":[{"title":"The Connect Webview Object","href":"/api/connect_webviews/object"},{"title":"Connect Webview Events","href":"/api/connect_webviews/events"},{"title":"Get a Connect Webview","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /connect_webviews/get","href":"/api/connect_webviews/get"},{"title":"List Connect Webviews","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /connect_webviews/list","href":"/api/connect_webviews/list"},{"title":"Create a Connect Webview","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /connect_webviews/create","href":"/api/connect_webviews/create"},{"title":"Delete a Connect Webview","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /connect_webviews/delete","href":"/api/connect_webviews/delete"}]},{"group":"Connected Accounts","pages":[{"title":"The Connected Account Object","href":"/api/connected_accounts/object"},{"title":"Connected Account Events","href":"/api/connected_accounts/events"},{"title":"Connected Account Errors and Warnings","href":"/api/connected_accounts/errors"},{"title":"Get a Connected Account","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /connected_accounts/get","href":"/api/connected_accounts/get"},{"title":"List Connected Accounts","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /connected_accounts/list","href":"/api/connected_accounts/list"},{"title":"Delete a Connected Account","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /connected_accounts/delete","href":"/api/connected_accounts/delete"},{"title":"Update a Connected Account","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /connected_accounts/update","href":"/api/connected_accounts/update"},{"title":"Sync a Connected Account","deprecated":null,"version":null,"sidebarTitle":"Sync","openapi":"/openapi.json post /connected_accounts/sync","href":"/api/connected_accounts/sync"},{"group":"Simulations","pages":[{"title":"Simulate","href":"/api/connected_accounts/simulate/object"},{"title":"Simulate Connected Account Disconnection","deprecated":null,"version":null,"sidebarTitle":"Disconnect","openapi":"/openapi.json post /connected_accounts/simulate/disconnect","href":"/api/connected_accounts/simulate/disconnect"}]}]},{"group":"User Identities","pages":[{"title":"The User Identity Object","href":"/api/user_identities/object"},{"title":"User Identity Errors and Warnings","href":"/api/user_identities/errors"},{"title":"Get a User Identity","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /user_identities/get","href":"/api/user_identities/get"},{"title":"List User Identities","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /user_identities/list","href":"/api/user_identities/list"},{"title":"Create a User Identity","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /user_identities/create","href":"/api/user_identities/create"},{"title":"Delete a User Identity","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /user_identities/delete","href":"/api/user_identities/delete"},{"title":"Update a User Identity","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /user_identities/update","href":"/api/user_identities/update"},{"title":"Add an ACS User to a User Identity","deprecated":null,"version":null,"sidebarTitle":"Add acs user","openapi":"/openapi.json put /user_identities/add_acs_user","href":"/api/user_identities/add_acs_user"},{"title":"Generate an Instant Key","deprecated":null,"version":null,"sidebarTitle":"Generate instant key","openapi":"/openapi.json post /user_identities/generate_instant_key","href":"/api/user_identities/generate_instant_key"},{"title":"Grant a User Identity Access to a Device","deprecated":null,"version":null,"sidebarTitle":"Grant access to device","openapi":"/openapi.json put /user_identities/grant_access_to_device","href":"/api/user_identities/grant_access_to_device"},{"title":"List Accessible Devices for a User Identity","deprecated":null,"version":null,"sidebarTitle":"List accessible devices","openapi":"/openapi.json get /user_identities/list_accessible_devices","href":"/api/user_identities/list_accessible_devices"},{"title":"List Accessible Entrances for a User Identity","deprecated":null,"version":null,"sidebarTitle":"List accessible entrances","openapi":"/openapi.json get /user_identities/list_accessible_entrances","href":"/api/user_identities/list_accessible_entrances"},{"title":"List ACS Systems Associated with a User Identity","deprecated":null,"version":null,"sidebarTitle":"List acs systems","openapi":"/openapi.json get /user_identities/list_acs_systems","href":"/api/user_identities/list_acs_systems"},{"title":"List ACS Users Associated with a User Identity","deprecated":null,"version":null,"sidebarTitle":"List acs users","openapi":"/openapi.json get /user_identities/list_acs_users","href":"/api/user_identities/list_acs_users"},{"title":"Merge User Identities","deprecated":null,"version":null,"sidebarTitle":"Merge","openapi":"/openapi.json post /user_identities/merge","href":"/api/user_identities/merge"},{"title":"Remove an ACS User from a User Identity","deprecated":null,"version":null,"sidebarTitle":"Remove acs user","openapi":"/openapi.json delete /user_identities/remove_acs_user","href":"/api/user_identities/remove_acs_user"},{"title":"Revoke Access to a Device from a User Identity","deprecated":null,"version":null,"sidebarTitle":"Revoke access to device","openapi":"/openapi.json delete /user_identities/revoke_access_to_device","href":"/api/user_identities/revoke_access_to_device"},{"group":"Unmanaged","pages":[{"title":"Unmanaged","href":"/api/user_identities/unmanaged/object"},{"title":"Unmanaged Errors and Warnings","href":"/api/user_identities/unmanaged/errors"},{"title":"Get an Unmanaged User Identity","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /user_identities/unmanaged/get","href":"/api/user_identities/unmanaged/get"},{"title":"List Unmanaged User Identities","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /user_identities/unmanaged/list","href":"/api/user_identities/unmanaged/list"},{"title":"Update an Unmanaged User Identity","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /user_identities/unmanaged/update","href":"/api/user_identities/unmanaged/update"}]}]},{"group":"Workspaces","pages":[{"title":"The Workspace Object","href":"/api/workspaces/object"},{"title":"Get a Workspace","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /workspaces/get","href":"/api/workspaces/get"},{"title":"List Workspaces","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /workspaces/list","href":"/api/workspaces/list"},{"title":"Create a Workspace","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /workspaces/create","href":"/api/workspaces/create"},{"title":"Update a Workspace","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /workspaces/update","href":"/api/workspaces/update"},{"title":"Reset a Sandbox Workspace","deprecated":null,"version":null,"sidebarTitle":"Reset sandbox","openapi":"/openapi.json post /workspaces/reset_sandbox","href":"/api/workspaces/reset_sandbox"}]},{"group":"Client Sessions","pages":[{"title":"The Client Session Object","href":"/api/client_sessions/object"},{"title":"Client Session Events","href":"/api/client_sessions/events"},{"title":"Get a Client Session","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /client_sessions/get","href":"/api/client_sessions/get"},{"title":"List Client Sessions","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /client_sessions/list","href":"/api/client_sessions/list"},{"title":"Create a Client Session","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json put /client_sessions/create","href":"/api/client_sessions/create"},{"title":"Delete a Client Session","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /client_sessions/delete","href":"/api/client_sessions/delete"},{"title":"Get or Create a Client Session","deprecated":null,"version":null,"sidebarTitle":"Get or create","openapi":"/openapi.json post /client_sessions/get_or_create","href":"/api/client_sessions/get_or_create"},{"title":"Grant Access to a Client Session","deprecated":null,"version":null,"sidebarTitle":"Grant access","openapi":"/openapi.json patch /client_sessions/grant_access","href":"/api/client_sessions/grant_access"},{"title":"Revoke a Client Session","deprecated":null,"version":null,"sidebarTitle":"Revoke","openapi":"/openapi.json post /client_sessions/revoke","href":"/api/client_sessions/revoke"}]},{"group":"Customers","pages":[{"title":"The Customer Object","href":"/api/customers/object"},{"title":"Create Customer Portal","deprecated":null,"version":null,"sidebarTitle":"Create portal","openapi":"/openapi.json post /customers/create_portal","href":"/api/customers/create_portal"},{"title":"Delete Customer Data","deprecated":null,"version":null,"sidebarTitle":"Delete data","openapi":"/openapi.json delete /customers/delete_data","href":"/api/customers/delete_data"},{"title":"Push Customer Data","deprecated":null,"version":null,"sidebarTitle":"Push data","openapi":"/openapi.json post /customers/push_data","href":"/api/customers/push_data"}]},{"group":"Spaces","pages":[{"title":"The Space Object","href":"/api/spaces/object"},{"title":"Space Events","href":"/api/spaces/events"},{"title":"Space Warnings","href":"/api/spaces/errors"},{"title":"Get a Space","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /spaces/get","href":"/api/spaces/get"},{"title":"List Spaces","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /spaces/list","href":"/api/spaces/list"},{"title":"Create a Space","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /spaces/create","href":"/api/spaces/create"},{"title":"Delete a Space","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /spaces/delete","href":"/api/spaces/delete"},{"title":"Update a Space","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /spaces/update","href":"/api/spaces/update"},{"title":"Add Entrances to a Space","deprecated":null,"version":null,"sidebarTitle":"Add acs entrances","openapi":"/openapi.json put /spaces/add_acs_entrances","href":"/api/spaces/add_acs_entrances"},{"title":"Add a Connected Account to a Space","deprecated":null,"version":null,"sidebarTitle":"Add connected account","openapi":"/openapi.json put /spaces/add_connected_account","href":"/api/spaces/add_connected_account"},{"title":"Add Devices to a Space","deprecated":null,"version":null,"sidebarTitle":"Add devices","openapi":"/openapi.json put /spaces/add_devices","href":"/api/spaces/add_devices"},{"title":"Get related Space resources","deprecated":null,"version":null,"sidebarTitle":"Get related","openapi":"/openapi.json get /spaces/get_related","href":"/api/spaces/get_related"},{"title":"Remove Entrances from a Space","deprecated":null,"version":null,"sidebarTitle":"Remove acs entrances","openapi":"/openapi.json delete /spaces/remove_acs_entrances","href":"/api/spaces/remove_acs_entrances"},{"title":"Remove a Connected Account from a Space","deprecated":null,"version":null,"sidebarTitle":"Remove connected account","openapi":"/openapi.json delete /spaces/remove_connected_account","href":"/api/spaces/remove_connected_account"},{"title":"Remove Devices from a Space","deprecated":null,"version":null,"sidebarTitle":"Remove devices","openapi":"/openapi.json delete /spaces/remove_devices","href":"/api/spaces/remove_devices"}]}]},{"group":"Monitoring","pages":[{"group":"Events","pages":[{"title":"The Event Object","href":"/api/events/object"},{"title":"Get an Event","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /events/get","href":"/api/events/get"},{"title":"List Events","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /events/list","href":"/api/events/list"}]},{"group":"Media","pages":[{"title":"The Media Object","href":"/api/media/object"},{"title":"Get Media","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /media/get","href":"/api/media/get"}]},{"group":"Webhooks","pages":[{"title":"The Webhook Object","href":"/api/webhooks/object"},{"title":"Get a Webhook","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /webhooks/get","href":"/api/webhooks/get"},{"title":"List Webhooks","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /webhooks/list","href":"/api/webhooks/list"},{"title":"Create a Webhook","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /webhooks/create","href":"/api/webhooks/create"},{"title":"Delete a Webhook","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /webhooks/delete","href":"/api/webhooks/delete"},{"title":"Update a Webhook","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json put /webhooks/update","href":"/api/webhooks/update"}]},{"group":"Action Attempts","pages":[{"title":"The Action Attempt Object","href":"/api/action_attempts/object"},{"title":"Action Attempt Events","href":"/api/action_attempts/events"},{"title":"Get an Action Attempt","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /action_attempts/get","href":"/api/action_attempts/get"},{"title":"List Action Attempts","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /action_attempts/list","href":"/api/action_attempts/list"}]}]},{"group":"Low-Level APIs","pages":[{"group":"Access Codes","pages":[{"title":"The Access Code Object","href":"/api/access_codes/object"},{"title":"Access Code Events","href":"/api/access_codes/events"},{"title":"Access Code Errors and Warnings","href":"/api/access_codes/errors"},{"title":"Get an Access Code","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /access_codes/get","href":"/api/access_codes/get"},{"title":"List Access Codes","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /access_codes/list","href":"/api/access_codes/list"},{"title":"Create an Access Code","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /access_codes/create","href":"/api/access_codes/create"},{"title":"Delete an Access Code","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /access_codes/delete","href":"/api/access_codes/delete"},{"title":"Update an Access Code","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /access_codes/update","href":"/api/access_codes/update"},{"title":"Create Multiple Linked Access Codes","deprecated":null,"version":null,"sidebarTitle":"Create multiple","openapi":"/openapi.json put /access_codes/create_multiple","href":"/api/access_codes/create_multiple"},{"title":"Generate a Code","deprecated":null,"version":null,"sidebarTitle":"Generate code","openapi":"/openapi.json get /access_codes/generate_code","href":"/api/access_codes/generate_code"},{"title":"Pull a Backup Access Code","deprecated":null,"version":null,"sidebarTitle":"Pull backup access code","openapi":"/openapi.json post /access_codes/pull_backup_access_code","href":"/api/access_codes/pull_backup_access_code"},{"title":"Report Device Access Code Constraints","deprecated":null,"version":null,"sidebarTitle":"Report device constraints","openapi":"/openapi.json post /access_codes/report_device_constraints","href":"/api/access_codes/report_device_constraints"},{"title":"Update Multiple Linked Access Codes","deprecated":null,"version":null,"sidebarTitle":"Update multiple","openapi":"/openapi.json patch /access_codes/update_multiple","href":"/api/access_codes/update_multiple"},{"group":"Simulations","pages":[{"title":"Access Code Simulations","href":"/api/access_codes/simulate/object"},{"title":"Simulate Creating an Unmanaged Access Code","deprecated":null,"version":null,"sidebarTitle":"Create unmanaged access code","openapi":"/openapi.json post /access_codes/simulate/create_unmanaged_access_code","href":"/api/access_codes/simulate/create_unmanaged_access_code"}]},{"group":"Unmanaged Access Codes","pages":[{"title":"Unmanaged Access Codes","href":"/api/access_codes/unmanaged/object"},{"title":"Unmanaged Access Codes Events","href":"/api/access_codes/unmanaged/events"},{"title":"Unmanaged Access Codes Errors and Warnings","href":"/api/access_codes/unmanaged/errors"},{"title":"Get an Unmanaged Access Code","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /access_codes/unmanaged/get","href":"/api/access_codes/unmanaged/get"},{"title":"List Unmanaged Access Codes","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /access_codes/unmanaged/list","href":"/api/access_codes/unmanaged/list"},{"title":"Delete an Unmanaged Access Code","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /access_codes/unmanaged/delete","href":"/api/access_codes/unmanaged/delete"},{"title":"Update an Unmanaged Access Code","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /access_codes/unmanaged/update","href":"/api/access_codes/unmanaged/update"},{"title":"Convert an Unmanaged Access Code","deprecated":null,"version":null,"sidebarTitle":"Convert to managed","openapi":"/openapi.json patch /access_codes/unmanaged/convert_to_managed","href":"/api/access_codes/unmanaged/convert_to_managed"}]}]},{"group":"Phones","pages":[{"title":"The Phone Object","href":"/api/phones/object"},{"title":"Phone Events","href":"/api/phones/events"},{"title":"Phone Errors and Warnings","href":"/api/phones/errors"},{"title":"Get a Phone","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /phones/get","href":"/api/phones/get"},{"title":"List Phones","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /phones/list","href":"/api/phones/list"},{"title":"Deactivate a Phone","deprecated":null,"version":null,"sidebarTitle":"Deactivate","openapi":"/openapi.json delete /phones/deactivate","href":"/api/phones/deactivate"},{"group":"Simulations","pages":[{"title":"Phone Simulations","href":"/api/phones/simulate/object"},{"title":"Create a Sandbox Phone","deprecated":null,"version":null,"sidebarTitle":"Create sandbox phone","openapi":"/openapi.json post /phones/simulate/create_sandbox_phone","href":"/api/phones/simulate/create_sandbox_phone"}]}]},{"group":"Instant Keys","pages":[{"title":"The Instant Key Object","href":"/api/instant_keys/object"},{"title":"Get an Instant Key","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /instant_keys/get","href":"/api/instant_keys/get"},{"title":"List Instant Keys","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /instant_keys/list","href":"/api/instant_keys/list"},{"title":"Delete an Instant Key","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /instant_keys/delete","href":"/api/instant_keys/delete"}]}]}]},{"tab":"Mobile SDKs","pages":[{"title":"Mobile SDKs","href":"/mobile-sdks"}]},{"tab":"Brand Guides","pages":[{"title":"Brand Guides","href":"/device-and-system-integration-guides"}]}]},"basePath":"","title":"Common Device Properties - Seam","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":[],"chunks":[]}