Type of the phone device, such as ios_phone or android_phone.
Enum values
ios_phone
android_phone
String
required
Display name of the phone. Defaults to nickname (if it is set) or properties.appearance.name, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.
Array of Objects
required
Array of errors associated with the device. Each error object within the array contains two fields: error_code and message. error_code is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. message provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
Show properties
Enum (String)
required
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values
account_disconnected
salto_ks_subscription_limit_exceeded
insufficient_permissions
dormakaba_sites_disconnected
device_offline
device_removed
hub_disconnected
device_disconnected
empty_backup_access_code_pool
august_lock_not_authorized
missing_device_credentials
auxiliary_heat_running
subscription_required
bridge_disconnected
String
required
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
Optional nickname to describe the phone, settable through Seam.
Object
required
Properties of the phone.
Show properties
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.
Array of Objects
required
Array of warnings associated with the device. Each warning object within the array contains two fields: warning_code and message. warning_code is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. message provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
Show properties
Enum (String)
required
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values
partial_backup_access_code_pool
many_active_backup_codes
third_party_integration_detected
ttlock_lock_gateway_unlocking_not_enabled
ttlock_weak_gateway_signal
power_saving_mode
temperature_threshold_exceeded
device_communication_degraded
scheduled_maintenance_window
device_has_flaky_connection
salto_ks_office_mode
salto_ks_privacy_mode
privacy_mode
salto_ks_subscription_limit_almost_reached
salto_ks_lock_access_code_support_removed
unknown_issue_with_phone
lockly_time_zone_not_configured
ultraloq_time_zone_unknown
time_zone_unknown
time_zone_mismatch
two_n_device_missing_timezone
hub_required_for_additional_capabilities
service_mode
provider_issue
keynest_unsupported_locker
accessory_keypad_setup_required
accessory_keypad_low_battery
unreliable_online_status
max_access_codes_reached
subscription_required_for_additional_capabilities
cloud_recording_not_enabled
String
required
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
String (ISO 8601)
required
Date and time at which Seam created the warning.
String (UUID)
required
ID of the workspace that contains the phone.
phone.properties
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.
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":"6afba2159235089491917ffe","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"API Reference","count":336},{"language":"default","tag":"Brand Guides","count":258},{"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":76},{"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":"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":"llms-txt-v2","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/phones/object","slug":"/api/phones/object","pageMetadata":{"title":"The Phone Object","description":"Learn how the phone object represents an app user mobile phone that holds mobile credentials, including its properties and lifecycle events.","href":"/api/phones/object"},"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: \"Learn how the phone object represents an app user mobile phone that holds mobile credentials, including its properties and lifecycle events.\"\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`,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:`the-phone-object`,children:`The phone Object`}),`\n`,_jsx(_components.p,{children:`Represents an app user’s mobile phone.`}),`\n`,`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`properties`,children:`Properties`}),`\n`,_jsx(ResponseField,{name:`created_at`,type:`String (ISO 8601)`,required:true,id:`param-created-at`,children:_jsx(_components.p,{children:`Date and time at which the phone was created.`})}),`\n`,_jsx(ResponseField,{name:`custom_metadata`,type:`Object (String, Boolean values)`,required:true,id:`param-custom-metadata`,children:_jsxs(_components.p,{children:[`Optional `,_jsx(_components.a,{href:`https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device`,children:`custom metadata`}),` for the phone.`]})}),`\n`,_jsx(ResponseField,{name:`device_id`,type:`String (UUID)`,required:true,id:`param-device-id`,children:_jsx(_components.p,{children:`ID of the phone.`})}),`\n`,_jsxs(ResponseField,{name:`device_type`,type:`Enum (String)`,required:true,id:`param-device-type`,children:[_jsxs(_components.p,{children:[`Type of the phone device, such as `,_jsx(_components.code,{children:`ios_phone`}),` or `,_jsx(_components.code,{children:`android_phone`}),`.`]}),_jsx(Accordion,{title:`Enum values`,id:`enum-values`,children:_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`ios_phone`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`android_phone`})}),`\n`]})})]}),`\n`,_jsx(ResponseField,{name:`display_name`,type:`String`,required:true,id:`param-display-name`,children:_jsxs(_components.p,{children:[`Display name of the phone. Defaults to `,_jsx(_components.code,{children:`nickname`}),` (if it is set) or `,_jsx(_components.code,{children:`properties.appearance.name`}),`, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.`]})}),`\n`,_jsxs(ResponseField,{name:`errors`,type:`Array of Objects`,required:true,id:`param-errors`,children:[_jsxs(_components.p,{children:[`Array of errors associated with the device. Each error object within the array contains two fields: `,_jsx(_components.code,{children:`error_code`}),` and `,_jsx(_components.code,{children:`message`}),`. `,_jsx(_components.code,{children:`error_code`}),` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `,_jsx(_components.code,{children:`message`}),` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`error_code`,id:`param-errors-error-code`,type:`Enum (String)`,required:true,children:[_jsx(_components.p,{children:`Unique identifier of the type of error. Enables quick recognition and categorization of the issue.`}),_jsx(Accordion,{title:`Enum values`,id:`enum-values-1`,children:_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`account_disconnected`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`salto_ks_subscription_limit_exceeded`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`insufficient_permissions`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`dormakaba_sites_disconnected`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`device_offline`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`device_removed`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`hub_disconnected`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`device_disconnected`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`empty_backup_access_code_pool`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`august_lock_not_authorized`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`missing_device_credentials`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`auxiliary_heat_running`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`subscription_required`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`bridge_disconnected`})}),`\n`]})})]}),_jsx(ResponseField,{name:`message`,id:`param-errors-message`,type:`String`,required:true,children:_jsx(_components.p,{children:`Detailed description of the error. Provides insights into the issue and potentially how to rectify it.`})}),_jsx(ResponseField,{name:`created_at`,id:`param-errors-created-at`,type:`String (ISO 8601)`,required:true,children:_jsx(_components.p,{children:`Date and time at which Seam created the error.`})}),_jsx(ResponseField,{name:`is_connected_account_error`,id:`param-errors-is-connected-account-error`,type:`Boolean`,children:_jsxs(_components.p,{children:[`Indicates that the error is a `,_jsx(_components.a,{href:`https://www.seam.co/docs/api/connected_accounts/object`,children:`connected account`}),` error.`]})}),_jsx(ResponseField,{name:`is_device_error`,id:`param-errors-is-device-error`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates that the error is a device error.`})})]})]}),`\n`,_jsx(ResponseField,{name:`nickname`,type:`String`,id:`param-nickname`,children:_jsx(_components.p,{children:`Optional nickname to describe the phone, settable through Seam.`})}),`\n`,_jsxs(ResponseField,{name:`properties`,type:`Object`,required:true,id:`param-properties`,children:[_jsx(_components.p,{children:`Properties of the phone.`}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`assa_abloy_credential_service_metadata`,type:`Object`,id:`param-assa-abloy-credential-service-metadata`,children:[_jsx(_components.p,{children:`ASSA ABLOY Credential Service metadata for the phone.`}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`endpoints`,type:`Array of Objects`,id:`param-endpoints`,children:[_jsx(_components.p,{children:`Endpoints associated with the phone.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`endpoint_id`,type:`String`,id:`param-endpoint-id`,children:_jsx(_components.p,{children:`ID of the associated endpoint.`})}),_jsx(ResponseField,{name:`is_active`,type:`Boolean`,id:`param-is-active`,children:_jsx(_components.p,{children:`Indicated whether the endpoint is active.`})})]})]}),_jsx(ResponseField,{name:`has_active_endpoint`,type:`Boolean`,id:`param-has-active-endpoint`,children:_jsx(_components.p,{children:`Indicates whether the credential service has active endpoints associated with the phone.`})})]})]}),_jsxs(ResponseField,{name:`salto_space_credential_service_metadata`,type:`Object`,id:`param-salto-space-credential-service-metadata`,children:[_jsx(_components.p,{children:`Salto Space credential service metadata for the phone.`}),_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`has_active_phone`,type:`Boolean`,id:`param-has-active-phone`,children:_jsx(_components.p,{children:`Indicates whether the credential service has an active associated phone.`})})})]})]})]}),`\n`,_jsxs(ResponseField,{name:`warnings`,type:`Array of Objects`,required:true,id:`param-warnings`,children:[_jsxs(_components.p,{children:[`Array of warnings associated with the device. Each warning object within the array contains two fields: `,_jsx(_components.code,{children:`warning_code`}),` and `,_jsx(_components.code,{children:`message`}),`. `,_jsx(_components.code,{children:`warning_code`}),` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `,_jsx(_components.code,{children:`message`}),` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`warning_code`,id:`param-warnings-warning-code`,type:`Enum (String)`,required:true,children:[_jsx(_components.p,{children:`Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.`}),_jsx(Accordion,{title:`Enum values`,id:`enum-values-2`,children:_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`partial_backup_access_code_pool`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`many_active_backup_codes`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`third_party_integration_detected`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`ttlock_lock_gateway_unlocking_not_enabled`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`ttlock_weak_gateway_signal`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`power_saving_mode`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`temperature_threshold_exceeded`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`device_communication_degraded`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`scheduled_maintenance_window`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`device_has_flaky_connection`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`salto_ks_office_mode`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`salto_ks_privacy_mode`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`privacy_mode`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`salto_ks_subscription_limit_almost_reached`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`salto_ks_lock_access_code_support_removed`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`unknown_issue_with_phone`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`lockly_time_zone_not_configured`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`ultraloq_time_zone_unknown`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`time_zone_unknown`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`time_zone_mismatch`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`two_n_device_missing_timezone`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`hub_required_for_additional_capabilities`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`service_mode`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`provider_issue`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`keynest_unsupported_locker`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`accessory_keypad_setup_required`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`accessory_keypad_low_battery`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`unreliable_online_status`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`max_access_codes_reached`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`subscription_required_for_additional_capabilities`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`cloud_recording_not_enabled`})}),`\n`]})})]}),_jsx(ResponseField,{name:`message`,id:`param-warnings-message`,type:`String`,required:true,children:_jsx(_components.p,{children:`Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.`})}),_jsx(ResponseField,{name:`created_at`,id:`param-warnings-created-at`,type:`String (ISO 8601)`,required:true,children:_jsx(_components.p,{children:`Date and time at which Seam created the warning.`})})]})]}),`\n`,_jsx(ResponseField,{name:`workspace_id`,type:`String (UUID)`,required:true,id:`param-workspace-id`,children:_jsx(_components.p,{children:`ID of the workspace that contains the phone.`})}),`\n`,_jsx(Heading,{level:`2`,id:`phone-properties`,children:`phone.properties`}),`\n`,_jsxs(ResponseField,{name:`assa_abloy_credential_service_metadata`,type:`Object`,id:`param-assa-abloy-credential-service-metadata-1`,children:[_jsx(_components.p,{children:`ASSA ABLOY Credential Service metadata for the phone.`}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`endpoints`,type:`Array of Objects`,id:`param-endpoints-1`,children:[_jsx(_components.p,{children:`Endpoints associated with the phone.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`endpoint_id`,type:`String`,id:`param-endpoint-id-1`,children:_jsx(_components.p,{children:`ID of the associated endpoint.`})}),_jsx(ResponseField,{name:`is_active`,type:`Boolean`,id:`param-is-active-1`,children:_jsx(_components.p,{children:`Indicated whether the endpoint is active.`})})]})]}),_jsx(ResponseField,{name:`has_active_endpoint`,type:`Boolean`,id:`param-has-active-endpoint-1`,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`,type:`Object`,id:`param-salto-space-credential-service-metadata-1`,children:[_jsx(_components.p,{children:`Salto Space credential service metadata for the phone.`}),_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`has_active_phone`,type:`Boolean`,id:`param-has-active-phone-1`,children:_jsx(_components.p,{children:`Indicates whether the credential service has an active associated phone.`})})})]})]})}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":"The Phone Object","description":"Learn how the phone object represents an app user mobile phone that holds mobile credentials, including its properties and lifecycle events.","href":"/api/phones/object"}}},"mdxSourceWithNoJs":{"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`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,CodeBlock,Expandable,Heading,ResponseExample,ResponseField}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`the-phone-object`,children:`The phone Object`}),`\n`,_jsx(_components.p,{children:`Represents an app user’s mobile phone.`}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`Phone`,numberOfLines:`24`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`24`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"2025-06-14T16:54:17.946540Z\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"custom_metadata\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"internalId1\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"device_id\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"e452f665-a635-4c65-922b-9feab0e0f84f\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"device_type\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"ios_phone\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"display_name\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"My Phone\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"errors\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: [],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"nickname\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"My Phone\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"properties\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"assa_abloy_credential_service_metadata\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"endpoints\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"endpoint_id\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"is_active\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"has_active_endpoint\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"warnings\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: [],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"workspace_id\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"da8639a4-28a2-4884-a4f9-b7691f4cf336\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`properties`,children:`Properties`}),`\n`,_jsx(ResponseField,{name:`created_at`,type:`String (ISO 8601)`,required:true,id:`param-created-at`,children:_jsx(_components.p,{children:`Date and time at which the phone was created.`})}),`\n`,_jsx(ResponseField,{name:`custom_metadata`,type:`Object (String, Boolean values)`,required:true,id:`param-custom-metadata`,children:_jsxs(_components.p,{children:[`Optional `,_jsx(_components.a,{href:`https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device`,children:`custom metadata`}),` for the phone.`]})}),`\n`,_jsx(ResponseField,{name:`device_id`,type:`String (UUID)`,required:true,id:`param-device-id`,children:_jsx(_components.p,{children:`ID of the phone.`})}),`\n`,_jsxs(ResponseField,{name:`device_type`,type:`Enum (String)`,required:true,id:`param-device-type`,children:[_jsxs(_components.p,{children:[`Type of the phone device, such as `,_jsx(_components.code,{children:`ios_phone`}),` or `,_jsx(_components.code,{children:`android_phone`}),`.`]}),_jsx(Accordion,{title:`Enum values`,id:`enum-values`,children:_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`ios_phone`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`android_phone`})}),`\n`]})})]}),`\n`,_jsx(ResponseField,{name:`display_name`,type:`String`,required:true,id:`param-display-name`,children:_jsxs(_components.p,{children:[`Display name of the phone. Defaults to `,_jsx(_components.code,{children:`nickname`}),` (if it is set) or `,_jsx(_components.code,{children:`properties.appearance.name`}),`, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.`]})}),`\n`,_jsxs(ResponseField,{name:`errors`,type:`Array of Objects`,required:true,id:`param-errors`,children:[_jsxs(_components.p,{children:[`Array of errors associated with the device. Each error object within the array contains two fields: `,_jsx(_components.code,{children:`error_code`}),` and `,_jsx(_components.code,{children:`message`}),`. `,_jsx(_components.code,{children:`error_code`}),` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `,_jsx(_components.code,{children:`message`}),` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`error_code`,id:`param-errors-error-code`,type:`Enum (String)`,required:true,children:[_jsx(_components.p,{children:`Unique identifier of the type of error. Enables quick recognition and categorization of the issue.`}),_jsx(Accordion,{title:`Enum values`,id:`enum-values-1`,children:_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`account_disconnected`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`salto_ks_subscription_limit_exceeded`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`insufficient_permissions`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`dormakaba_sites_disconnected`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`device_offline`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`device_removed`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`hub_disconnected`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`device_disconnected`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`empty_backup_access_code_pool`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`august_lock_not_authorized`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`missing_device_credentials`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`auxiliary_heat_running`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`subscription_required`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`bridge_disconnected`})}),`\n`]})})]}),_jsx(ResponseField,{name:`message`,id:`param-errors-message`,type:`String`,required:true,children:_jsx(_components.p,{children:`Detailed description of the error. Provides insights into the issue and potentially how to rectify it.`})}),_jsx(ResponseField,{name:`created_at`,id:`param-errors-created-at`,type:`String (ISO 8601)`,required:true,children:_jsx(_components.p,{children:`Date and time at which Seam created the error.`})}),_jsx(ResponseField,{name:`is_connected_account_error`,id:`param-errors-is-connected-account-error`,type:`Boolean`,children:_jsxs(_components.p,{children:[`Indicates that the error is a `,_jsx(_components.a,{href:`https://www.seam.co/docs/api/connected_accounts/object`,children:`connected account`}),` error.`]})}),_jsx(ResponseField,{name:`is_device_error`,id:`param-errors-is-device-error`,type:`Boolean`,children:_jsx(_components.p,{children:`Indicates that the error is a device error.`})})]})]}),`\n`,_jsx(ResponseField,{name:`nickname`,type:`String`,id:`param-nickname`,children:_jsx(_components.p,{children:`Optional nickname to describe the phone, settable through Seam.`})}),`\n`,_jsxs(ResponseField,{name:`properties`,type:`Object`,required:true,id:`param-properties`,children:[_jsx(_components.p,{children:`Properties of the phone.`}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`assa_abloy_credential_service_metadata`,type:`Object`,id:`param-assa-abloy-credential-service-metadata`,children:[_jsx(_components.p,{children:`ASSA ABLOY Credential Service metadata for the phone.`}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`endpoints`,type:`Array of Objects`,id:`param-endpoints`,children:[_jsx(_components.p,{children:`Endpoints associated with the phone.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`endpoint_id`,type:`String`,id:`param-endpoint-id`,children:_jsx(_components.p,{children:`ID of the associated endpoint.`})}),_jsx(ResponseField,{name:`is_active`,type:`Boolean`,id:`param-is-active`,children:_jsx(_components.p,{children:`Indicated whether the endpoint is active.`})})]})]}),_jsx(ResponseField,{name:`has_active_endpoint`,type:`Boolean`,id:`param-has-active-endpoint`,children:_jsx(_components.p,{children:`Indicates whether the credential service has active endpoints associated with the phone.`})})]})]}),_jsxs(ResponseField,{name:`salto_space_credential_service_metadata`,type:`Object`,id:`param-salto-space-credential-service-metadata`,children:[_jsx(_components.p,{children:`Salto Space credential service metadata for the phone.`}),_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`has_active_phone`,type:`Boolean`,id:`param-has-active-phone`,children:_jsx(_components.p,{children:`Indicates whether the credential service has an active associated phone.`})})})]})]})]}),`\n`,_jsxs(ResponseField,{name:`warnings`,type:`Array of Objects`,required:true,id:`param-warnings`,children:[_jsxs(_components.p,{children:[`Array of warnings associated with the device. Each warning object within the array contains two fields: `,_jsx(_components.code,{children:`warning_code`}),` and `,_jsx(_components.code,{children:`message`}),`. `,_jsx(_components.code,{children:`warning_code`}),` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `,_jsx(_components.code,{children:`message`}),` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`warning_code`,id:`param-warnings-warning-code`,type:`Enum (String)`,required:true,children:[_jsx(_components.p,{children:`Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.`}),_jsx(Accordion,{title:`Enum values`,id:`enum-values-2`,children:_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`partial_backup_access_code_pool`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`many_active_backup_codes`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`third_party_integration_detected`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`ttlock_lock_gateway_unlocking_not_enabled`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`ttlock_weak_gateway_signal`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`power_saving_mode`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`temperature_threshold_exceeded`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`device_communication_degraded`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`scheduled_maintenance_window`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`device_has_flaky_connection`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`salto_ks_office_mode`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`salto_ks_privacy_mode`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`privacy_mode`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`salto_ks_subscription_limit_almost_reached`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`salto_ks_lock_access_code_support_removed`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`unknown_issue_with_phone`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`lockly_time_zone_not_configured`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`ultraloq_time_zone_unknown`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`time_zone_unknown`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`time_zone_mismatch`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`two_n_device_missing_timezone`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`hub_required_for_additional_capabilities`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`service_mode`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`provider_issue`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`keynest_unsupported_locker`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`accessory_keypad_setup_required`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`accessory_keypad_low_battery`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`unreliable_online_status`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`max_access_codes_reached`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`subscription_required_for_additional_capabilities`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`cloud_recording_not_enabled`})}),`\n`]})})]}),_jsx(ResponseField,{name:`message`,id:`param-warnings-message`,type:`String`,required:true,children:_jsx(_components.p,{children:`Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.`})}),_jsx(ResponseField,{name:`created_at`,id:`param-warnings-created-at`,type:`String (ISO 8601)`,required:true,children:_jsx(_components.p,{children:`Date and time at which Seam created the warning.`})})]})]}),`\n`,_jsx(ResponseField,{name:`workspace_id`,type:`String (UUID)`,required:true,id:`param-workspace-id`,children:_jsx(_components.p,{children:`ID of the workspace that contains the phone.`})}),`\n`,_jsx(Heading,{level:`2`,id:`phone-properties`,children:`phone.properties`}),`\n`,_jsxs(ResponseField,{name:`assa_abloy_credential_service_metadata`,type:`Object`,id:`param-assa-abloy-credential-service-metadata-1`,children:[_jsx(_components.p,{children:`ASSA ABLOY Credential Service metadata for the phone.`}),_jsxs(Expandable,{title:`properties`,children:[_jsxs(ResponseField,{name:`endpoints`,type:`Array of Objects`,id:`param-endpoints-1`,children:[_jsx(_components.p,{children:`Endpoints associated with the phone.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`endpoint_id`,type:`String`,id:`param-endpoint-id-1`,children:_jsx(_components.p,{children:`ID of the associated endpoint.`})}),_jsx(ResponseField,{name:`is_active`,type:`Boolean`,id:`param-is-active-1`,children:_jsx(_components.p,{children:`Indicated whether the endpoint is active.`})})]})]}),_jsx(ResponseField,{name:`has_active_endpoint`,type:`Boolean`,id:`param-has-active-endpoint-1`,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`,type:`Object`,id:`param-salto-space-credential-service-metadata-1`,children:[_jsx(_components.p,{children:`Salto Space credential service metadata for the phone.`}),_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`has_active_phone`,type:`Boolean`,id:`param-has-active-phone-1`,children:_jsx(_components.p,{children:`Indicates whether the credential service has an active associated phone.`})})})]})]})}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":"The Phone Object","description":"Learn how the phone object represents an app user mobile phone that holds mobile credentials, including its properties and lifecycle events.","href":"/api/phones/object"}}}},"mdxExtracts":{"tableOfContents":[{"title":"The phone Object","slug":"the-phone-object","depth":2,"children":[]},{"title":"Properties","slug":"properties","depth":2,"children":[]},{"title":"phone.properties","slug":"phone-properties","depth":2,"children":[]}],"codeExamples":{"response":{"type":"ResponseExample","children":[{"filename":"Phone","html":"\u003cpre class=\"shiki shiki-themes dark-plus dark-plus\" style=\"background-color:#0B0C0E;--shiki-dark-bg:#0B0C0E;color:#D4D4D4;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"24\">\u003cspan class=\"line\">\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"created_at\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#CE9178;--shiki-dark:#CE9178\">\"2025-06-14T16:54:17.946540Z\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"custom_metadata\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#CE9178;--shiki-dark:#CE9178\">\"internalId1\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"device_id\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#CE9178;--shiki-dark:#CE9178\">\"e452f665-a635-4c65-922b-9feab0e0f84f\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"device_type\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#CE9178;--shiki-dark:#CE9178\">\"ios_phone\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"display_name\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#CE9178;--shiki-dark:#CE9178\">\"My Phone\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"errors\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: [],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"nickname\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#CE9178;--shiki-dark:#CE9178\">\"My Phone\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"properties\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"assa_abloy_credential_service_metadata\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"endpoints\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"endpoint_id\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#CE9178;--shiki-dark:#CE9178\">\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"is_active\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#569CD6;--shiki-dark:#569CD6\">true\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"has_active_endpoint\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#569CD6;--shiki-dark:#569CD6\">true\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"warnings\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: [],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"workspace_id\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#CE9178;--shiki-dark:#CE9178\">\"da8639a4-28a2-4884-a4f9-b7691f4cf336\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}}},"jsLinks":["/docs/_mintlify/custom/seam/4d860677184e9142/pylon.js","/docs/_mintlify/custom/seam/18bfb52c609a48d7/custom.js"],"subdomain":"seam","siteName":"Seam","title":"The Phone Object - Seam","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T00:43:34.648Z","originalFileLocation":"api/phones/object.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=\"Learn how the phone object represents an app user mobile phone that holds mobile credentials, including its properties and lifecycle events.\">\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=\"The Phone Object - Seam\">\u003cmeta data-mint-head property=\"og:description\" content=\"Learn how the phone object represents an app user mobile phone that holds mobile credentials, including its properties and lifecycle events.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Seam\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.seam.co/docs/api/phones/object\">\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=\"The Phone Object - Seam\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Learn how the phone object represents an app user mobile phone that holds mobile credentials, including its properties and lifecycle events.\">\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/phones/object\">\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/phones/object.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/phones/object#webpage\",\"url\":\"https://www.seam.co/docs/api/phones/object\",\"name\":\"The Phone Object\",\"description\":\"Learn how the phone object represents an app user mobile phone that holds mobile credentials, including its properties and lifecycle events.\",\"dateModified\":\"2026-11-13T00:43:34.648Z\",\"isPartOf\":{\"@id\":\"https://www.seam.co/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.seam.co/docs/api/phones/object#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.seam.co/docs/api/phones/object#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Low-Level APIs\",\"item\":\"https://www.seam.co/docs/api/access_codes/object\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"The Phone Object\",\"item\":\"https://www.seam.co/docs/api/phones/object\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://www.seam.co/docs/api/phones/object#article\",\"headline\":\"The Phone Object\",\"name\":\"The Phone Object\",\"description\":\"Learn how the phone object represents an app user mobile phone that holds mobile credentials, including its properties and lifecycle events.\",\"url\":\"https://www.seam.co/docs/api/phones/object\",\"mainEntityOfPage\":{\"@id\":\"https://www.seam.co/docs/api/phones/object#webpage\"},\"image\":\"https://www.seam.co/docs/images/seam-og-default.jpg\",\"dateModified\":\"2026-11-13T00:43:34.648Z\",\"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/phones/object.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","href":"/api/devices/object"},{"title":"Common Device Properties","href":"/api/devices/properties"},{"title":"Device Examples","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","description":"Converts an unmanaged access code to an access code managed through Seam. Seam API reference: PATCH /access_codes/unmanaged/convert_to_managed.","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","description":"Reference for Seam Phone webhook events, including event names, JSON payload examples, and the properties your app receives.","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":"The Phone Object - Seam","buildId":"dpl_5Wnaxc3m8t3HZwdvwe36fSBdcT12","deploymentId":"dpl_5Wnaxc3m8t3HZwdvwe36fSBdcT12","dynamics":["2b790eda92"],"chunks":["ApiExamples-CuiF8xsJ.js","utils-S4bU2zRv.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","cloneDeep-izs3Hzxb.js","utils-BC7mpg-s.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ToTaBa32.js","shallow-Bw_UfCTY.js","snippetPresets-DXO56z8S.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","getApiPlaygroundDisplay-BFcVyT7w.js","CodeSnippet-DWwGgYk5.js","CodeSnippets-hAOKmdpX.js"]}