Generates a code for an access code, given a device ID. Reference for GET /access_codes/generate_code in the Seam API, with request and response details.
{"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":""},"chroma":{"liveDeploymentHistoryId":"6add417c4a5b340ece6c5f39","collectionId":"e6828bc9-4dfd-4dcf-899d-27ba3186ad48","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6add417c4a5b340ece6c5f39"},"feedback":{"thumbs":true,"issues":false,"edits":false},"entitlements":{},"buildId":"6add417c4a5b340ece6c5f39","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API Reference","count":322},{"language":"default","tag":"Brand Guides","count":247},{"language":"default","tag":"Guides","count":198},{"language":"default","tag":"Devices and Systems","count":139},{"language":"default","tag":"Access Control Systems","count":124},{"language":"default","tag":"Smart Locks","count":102},{"language":"default","tag":"Low-Level APIs","count":72},{"language":"default","tag":"Setup","count":69},{"language":"default","tag":"Thermostats","count":68},{"language":"default","tag":"Access Control Systems (ACS)","count":62}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".seam-property-index{max-height:20rem;overflow-y:auto;padding:.75rem;border-radius:.5rem;background:var(--seam-surface-2)}a.seam-ref{display:block;font-size:.875rem;scroll-margin-top:10rem}: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 .5px 0 0 rgb(9 10 11/.1) inset,0 -.5px 0 0 rgb(9 10 11/.1) inset}.dark .seam-section-alt{box-shadow:0 .5px 0 0 rgb(255 255 255/.08) inset,0 -.5px 0 0 rgb(255 255 255/.08) inset}.seam-hero{padding:5rem 0 3rem;background:radial-gradient(60% 50% at 50% 0%,color-mix(in srgb,var(--seam-primary-500) 10%,transparent),transparent 70%)}.dark .seam-hero{background:radial-gradient(60% 50% at 50% 0%,color-mix(in srgb,var(--seam-primary-400) 16%,transparent),transparent 70%)}.seam-h1{font-size:clamp(2rem,4.5vw,3.25rem);line-height:1.1;font-weight:600;letter-spacing:-.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:-.02em;color:var(--seam-txt-1);margin: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:.625rem 1.125rem;border-radius:.5rem;font-weight:525;font-size:.9375rem;text-decoration:none!important;transition:background 120ms,box-shadow 120ms}.seam-btn-primary{background:var(--seam-gray-950);color:#fff!important;box-shadow:0 12px 16px 0 rgb(255 255 255/.06) inset,0 4px 4px 0 rgb(9 10 11/.08),0 1px 2px 0 rgb(9 10 11/.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,.dark .seam-logo-grid a: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:.75rem;background:var(--seam-card)}.seam-agent-card{background:var(--seam-gray-950);box-shadow:0 .5px 0 0 #090a0b inset,0 1px 0 0 rgb(255 255 255/.12) inset,0 12px 24px 0 rgb(9 10 11/.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:0 0;box-shadow:none;border:0;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/.14);margin:.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:-.02em;color:var(--seam-txt-1);margin:0 0 .5rem}.seam-agent-desc{font-size:.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:.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:.9375rem;font-weight:525;line-height:1.5;color:var(--seam-gray-950);background:#fff;border:0;border-radius:.5rem;padding:.625rem 1.125rem;box-shadow:0 2px 8px 0 rgb(9 10 11/.35);transition:background 120ms,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% + .375rem);z-index:30;min-width:11.5rem;flex-direction:column;padding:.25rem;border-radius:.5rem;background:var(--seam-gray-800);box-shadow:0 0 0 .5px rgb(255 255 255/.12) inset,0 8px 24px 0 rgb(9 10 11/.4)}.seam-open-menu.open .seam-open-list{display:flex}.seam-open-list a,.seam-open-list button{text-align:left;font-size:.8125rem;font-weight:475;color:rgb(255 255 255/.9)!important;text-decoration:none!important;background:0 0;border:0;cursor:pointer;padding:.4375rem .625rem;border-radius:.375rem;white-space:nowrap}.seam-open-list a:hover,.seam-open-list button:hover{background:rgb(255 255 255/.1)}.seam-agent-code .code-block,.seam-hero-cell .code-block{margin:0}.seam-code-label{font-size:.75rem;font-weight:600;letter-spacing:.08em;text-transform:uppercase;color:var(--seam-txt-3);margin:0 0 .625rem}.seam-section .card h2,.seam-section [class*=card] h2{font-size:.9375rem}.seam-sdk-row{display:flex;flex-wrap:wrap;gap:.625rem}.seam-sdk{display:inline-flex;align-items:center;gap:.5rem;padding:.5rem .875rem;border-radius:.5rem;font-size:.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-logo-grid a:hover,.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-logo-grid a,.seam-video-frame{border-radius:.5rem;box-shadow:var(--seam-stroke)}.seam-video-frame{position:relative;aspect-ratio:16/9;overflow:hidden;background:var(--seam-gray-950)}.seam-video-frame iframe{position:absolute;inset:0;width:100%;height:100%}.seam-video-title{font-weight:525;font-size:.9375rem;color:var(--seam-txt-1);margin:.75rem 0 .125rem}.seam-video-desc{font-size:.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:.75rem}.seam-logo-grid a{display:flex;align-items:center;justify-content:center;height:64px;padding:.75rem;background:var(--seam-card);transition:background 120ms}.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)}.seam-footer-strip{padding-top:2rem;padding-bottom:5rem}"}],"page":{"pagePath":"api/access_codes/generate_code","slug":"/api/access_codes/generate_code","pageMetadata":{"title":"Generate a Code","description":"Generates a code for an access code, given a device ID. Reference for GET /access_codes/generate_code in the Seam API, with request and response details.","deprecated":null,"version":null,"sidebarTitle":"Generate code","openapi":"/openapi.json get /access_codes/generate_code","href":"/api/access_codes/generate_code","autogeneratedByOpenApi":true},"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: \"Generates a code for an access code, given a device ID. Reference for GET /access_codes/generate_code in the Seam API, with request and response details.\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`Generates a code for an `,_jsx(_components.a,{href:`https://www.seam.co/docs/low-level-apis/smart-locks/access-codes`,children:`access code`}),`, given a device ID.`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Generate a Code","description":"Generates a code for an access code, given a device ID. Reference for GET /access_codes/generate_code in the Seam API, with request and response details.","deprecated":null,"version":null,"sidebarTitle":"Generate code","openapi":"/openapi.json get /access_codes/generate_code","href":"/api/access_codes/generate_code","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/seam/4d860677184e9142/pylon.js","/docs/_mintlify/custom/seam/837cf91ae1184adb/custom.js"],"openApiReferenceData":{"operation":{"description":"Generates a code for an access code, given a device ID. Reference for GET /access_codes/generate_code in the Seam API, with request and response details.","operationId":"accessCodesGenerateCodeGet","parameters":["00d90059-2846-4cbe-9689-abaea29e2ac1"],"responses":{"200":"539a3f0a-46a9-44e1-b75d-f6ba3dda144f","400":"b7790030-77ca-4dbe-bbc6-86828a43b757","401":"ccea74c3-15eb-43d4-be21-771a15c5720e"},"security":["92b9c228-a3cf-4f7e-9fe2-ade55656c352","d93ea0cb-83e8-433f-9c08-42cf55e4f12c","04624ef0-b8ce-4d00-95a4-9c8e1707d594","a695a2bb-fa1c-4051-99b9-453ee0dc4af5","8ec49bd6-8919-4058-ae09-18c4ecf38cad"],"summary":"Generate a Code","tags":["/access_codes"],"x-response-key":"generated_code","x-title":"Generate a Code","x-mint":{"href":"/api/access_codes/generate_code","metadata":{"description":"Generates a code for an access code, given a device ID. Reference for GET /access_codes/generate_code in the Seam API, with request and response details."},"content":"Generates a code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes), given a device ID."},"x-codeSamples":[{"lang":"javascript","label":"Seam SDK","source":"await seam.accessCodes.generateCode({\n device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n});\n\n/*\n{\n \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n \"code\": \"1234\"\n}\n*/"},{"lang":"bash","label":"cURL","source":"curl --include --request POST \"https://connect.getseam.com/access_codes/generate_code\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- \u003c\u003cEOF\n{\n \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\"\n}\nEOF\n\n# Response:\n# {\n# \"generated_code\": {\n# \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n# \"code\": \"1234\"\n# }\n# }"},{"lang":"python","label":"Seam SDK","source":"seam.access_codes.generate_code(device_id=\"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\")\n\n# AccessCode(device_id=\"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\", code=\"1234\")"},{"lang":"ruby","label":"Seam SDK","source":"seam.access_codes.generate_code(device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\")\n\n# => { \"device_id\" => \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\", \"code\" => \"1234\" }"},{"lang":"php","label":"Seam SDK","source":"$seam->access_codes->generate_code(\n device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n);\n\n// [\"device_id\" => \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\", \"code\" => \"1234\"];"},{"lang":"bash","label":"Seam CLI","source":"seam access-codes generate-code --device_id \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\"\n\n# {\n# \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n# \"code\": \"1234\"\n# }"}],"method":"get","type":"path","servers":["b50d4898-2dfb-42da-9d6d-a891d229f9f8"],"path":"/access_codes/generate_code","baseUrlOptions":["https://connect.getseam.com"],"title":"Generate a Code","codeSamples":[{"label":"Seam SDK","lang":"javascript","source":"await seam.accessCodes.generateCode({\n device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n});\n\n/*\n{\n \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n \"code\": \"1234\"\n}\n*/"},{"label":"cURL","lang":"bash","source":"curl --include --request POST \"https://connect.getseam.com/access_codes/generate_code\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- \u003c\u003cEOF\n{\n \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\"\n}\nEOF\n\n# Response:\n# {\n# \"generated_code\": {\n# \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n# \"code\": \"1234\"\n# }\n# }"},{"label":"Seam SDK","lang":"python","source":"seam.access_codes.generate_code(device_id=\"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\")\n\n# AccessCode(device_id=\"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\", code=\"1234\")"},{"label":"Seam SDK","lang":"ruby","source":"seam.access_codes.generate_code(device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\")\n\n# => { \"device_id\" => \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\", \"code\" => \"1234\" }"},{"label":"Seam SDK","lang":"php","source":"$seam->access_codes->generate_code(\n device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n);\n\n// [\"device_id\" => \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\", \"code\" => \"1234\"];"},{"label":"Seam CLI","lang":"bash","source":"seam access-codes generate-code --device_id \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\"\n\n# {\n# \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n# \"code\": \"1234\"\n# }"}],"requiredOnlyExamples":false,"disableCodeSampleGeneration":true,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"00d90059-2846-4cbe-9689-abaea29e2ac1":{"in":"query","name":"device_id","required":true,"schema":{"description":"ID of the device for which you want to generate a code.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"539a3f0a-46a9-44e1-b75d-f6ba3dda144f":{"content":{"application/json":{"schema":{"properties":{"generated_code":{"description":"Represents a smart lock [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). See the [access_code object](https://www.seam.co/docs/api/access_codes/object).","properties":{"access_code_id":{"description":"Unique identifier for the access code.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"generated_code.access_code_id","typeLabel":"string\u003cuuid>"},"code":{"oneOf":[{"description":"Code used for access. Typically, a numeric or alphanumeric string.","type":"string","isRequired":true,"uniqueKey":"generated_code.code.oneOf.0","typeLabel":"string"},{"description":"Code used for access. Typically, a numeric or alphanumeric string.","type":"null","isRequired":true,"uniqueKey":"generated_code.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"generated_code.code","typeLabel":"string | null"},"common_code_key":{"oneOf":[{"description":"Unique identifier for a group of access codes that share the same code.","type":"string","isRequired":true,"uniqueKey":"generated_code.common_code_key.oneOf.0","typeLabel":"string"},{"description":"Unique identifier for a group of access codes that share the same code.","type":"null","isRequired":true,"uniqueKey":"generated_code.common_code_key.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"generated_code.common_code_key","typeLabel":"string | null"},"created_at":{"description":"Date and time at which the access code was created.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"generated_code.created_at","typeLabel":"string\u003cdate-time>"},"device_id":{"description":"Unique identifier for the device associated with the access code.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"generated_code.device_id","typeLabel":"string\u003cuuid>"},"display_status":{"description":"Human-readable label for where this access code sits in its lifecycle, for example `Active`, `Issuing`, or `Expired`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`.","type":"string","isRequired":true,"uniqueKey":"generated_code.display_status","typeLabel":"string"},"errors":{"type":"array","description":"Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).","items":{"type":"object","properties":{"error_code":{"type":"string","description":"Error or warning code.","uniqueKey":"generated_code.errors.items.[INDEX].error_code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description.","uniqueKey":"generated_code.errors.items.[INDEX].message","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"When this error or warning was generated.","uniqueKey":"generated_code.errors.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"generated_code.errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"generated_code.errors","typeLabel":"object[]"},"is_backup_access_code_available":{"description":"Indicates whether a backup access code is available for use if the primary access code is lost or compromised.","type":"boolean","isRequired":true,"uniqueKey":"generated_code.is_backup_access_code_available","typeLabel":"boolean"},"is_external_modification_allowed":{"description":"Indicates whether changes to the access code from external sources are permitted.","type":"boolean","isRequired":true,"uniqueKey":"generated_code.is_external_modification_allowed","typeLabel":"boolean"},"is_managed":{"description":"Indicates whether Seam manages the access code.","enum":[true],"type":"boolean","isRequired":true,"uniqueKey":"generated_code.is_managed","typeLabel":"enum\u003cboolean>"},"is_offline_access_code":{"description":"Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection.","type":"boolean","isRequired":true,"uniqueKey":"generated_code.is_offline_access_code","typeLabel":"boolean"},"is_one_time_use":{"description":"Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use.","type":"boolean","isRequired":true,"uniqueKey":"generated_code.is_one_time_use","typeLabel":"boolean"},"name":{"oneOf":[{"description":"Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).","type":"string","isRequired":true,"uniqueKey":"generated_code.name.oneOf.0","typeLabel":"string"},{"description":"Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).","type":"null","isRequired":true,"uniqueKey":"generated_code.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"generated_code.name","typeLabel":"string | null"},"pending_mutations":{"description":"Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device.","items":{"oneOf":[{"type":"object","description":"Seam is in the process of setting an access code on the device.","required":["created_at","message","mutation_code"],"properties":{"created_at":{"description":"Date and time at which the mutation was created.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"message":{"description":"Detailed description of the mutation.","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.0.message","typeLabel":"string"},"mutation_code":{"description":"Mutation code to indicate that Seam is in the process of setting an access code on the device.","enum":["creating"],"type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.0.mutation_code","typeLabel":"enum\u003cstring>"}},"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"Seam is waiting until closer to the access code's start time before programming it on the device.","required":["created_at","message","mutation_code","scheduled_at"],"properties":{"created_at":{"description":"Date and time at which the mutation was created.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"message":{"description":"Detailed description of the mutation.","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.1.message","typeLabel":"string"},"mutation_code":{"description":"Mutation code to indicate that Seam is waiting until closer to the access code's start time before programming it on the device.","enum":["deferring_creation"],"type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.1.mutation_code","typeLabel":"enum\u003cstring>"},"scheduled_at":{"description":"Date and time at which Seam will attempt to program this access code on the device.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.1.scheduled_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"Seam is in the process of removing an access code from the device.","required":["created_at","message","mutation_code"],"properties":{"created_at":{"description":"Date and time at which the mutation was created.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.2.created_at","typeLabel":"string\u003cdate-time>"},"message":{"description":"Detailed description of the mutation.","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.2.message","typeLabel":"string"},"mutation_code":{"description":"Mutation code to indicate that Seam is in the process of removing an access code from the device.","enum":["deleting"],"type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.2.mutation_code","typeLabel":"enum\u003cstring>"}},"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"Seam is in the process of pushing an updated PIN code to the device.","required":["created_at","message","mutation_code","from","to"],"properties":{"created_at":{"description":"Date and time at which the mutation was created.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.3.created_at","typeLabel":"string\u003cdate-time>"},"from":{"description":"Previous code configuration.","properties":{"code":{"oneOf":[{"description":"Previous PIN code.","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.3.from.code.oneOf.0","typeLabel":"string"},{"description":"Previous PIN code.","type":"null","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.3.from.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.3.from.code","typeLabel":"string | null"}},"required":["code"],"type":"object","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.3.from","typeLabel":"object"},"message":{"description":"Detailed description of the mutation.","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.3.message","typeLabel":"string"},"mutation_code":{"description":"Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device.","enum":["updating_code"],"type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.3.mutation_code","typeLabel":"enum\u003cstring>"},"to":{"description":"New code configuration.","properties":{"code":{"oneOf":[{"description":"New PIN code.","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.3.to.code.oneOf.0","typeLabel":"string"},{"description":"New PIN code.","type":"null","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.3.to.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.3.to.code","typeLabel":"string | null"}},"required":["code"],"type":"object","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.3.to","typeLabel":"object"}},"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","description":"Seam is in the process of pushing an updated access code name to the device.","required":["created_at","message","mutation_code","from","to"],"properties":{"created_at":{"description":"Date and time at which the mutation was created.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.4.created_at","typeLabel":"string\u003cdate-time>"},"from":{"description":"Previous name configuration.","properties":{"name":{"oneOf":[{"description":"Previous access code name.","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.4.from.name.oneOf.0","typeLabel":"string"},{"description":"Previous access code name.","type":"null","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.4.from.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.4.from.name","typeLabel":"string | null"}},"required":["name"],"type":"object","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.4.from","typeLabel":"object"},"message":{"description":"Detailed description of the mutation.","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.4.message","typeLabel":"string"},"mutation_code":{"description":"Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device.","enum":["updating_name"],"type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.4.mutation_code","typeLabel":"enum\u003cstring>"},"to":{"description":"New name configuration.","properties":{"name":{"oneOf":[{"description":"New access code name.","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.4.to.name.oneOf.0","typeLabel":"string"},{"description":"New access code name.","type":"null","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.4.to.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.4.to.name","typeLabel":"string | null"}},"required":["name"],"type":"object","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.4.to","typeLabel":"object"}},"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","description":"Seam is in the process of pushing an updated time frame to the device.","required":["created_at","message","mutation_code","from","to"],"properties":{"created_at":{"description":"Date and time at which the mutation was created.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.created_at","typeLabel":"string\u003cdate-time>"},"from":{"description":"Previous time frame configuration.","properties":{"ends_at":{"oneOf":[{"description":"Previous end time for the access code.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.from.ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Previous end time for the access code.","format":"date-time","type":"null","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.from.ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.from.ends_at","typeLabel":"string\u003cdate-time> | null"},"starts_at":{"oneOf":[{"description":"Previous start time for the access code.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.from.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Previous start time for the access code.","format":"date-time","type":"null","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.from.starts_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.from.starts_at","typeLabel":"string\u003cdate-time> | null"}},"required":["starts_at","ends_at"],"type":"object","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.from","typeLabel":"object"},"message":{"description":"Detailed description of the mutation.","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.message","typeLabel":"string"},"mutation_code":{"description":"Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device.","enum":["updating_time_frame"],"type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.mutation_code","typeLabel":"enum\u003cstring>"},"to":{"description":"New time frame configuration.","properties":{"ends_at":{"oneOf":[{"description":"New end time for the access code.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.to.ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"New end time for the access code.","format":"date-time","type":"null","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.to.ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.to.ends_at","typeLabel":"string\u003cdate-time> | null"},"starts_at":{"oneOf":[{"description":"New start time for the access code.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.to.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"New start time for the access code.","format":"date-time","type":"null","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.to.starts_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.to.starts_at","typeLabel":"string\u003cdate-time> | null"}},"required":["starts_at","ends_at"],"type":"object","isRequired":true,"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5.to","typeLabel":"object"}},"uniqueKey":"generated_code.pending_mutations.items.[INDEX].oneOf.5","typeLabel":"object"}],"uniqueKey":"generated_code.pending_mutations.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"generated_code.pending_mutations","typeLabel":"object[]"},"status":{"deprecated":true,"description":"Deprecated. Use `display_status` to show a person the code's state. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`.\n\nCurrent status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).","enum":["setting","set","unset","removing","unknown"],"type":"string","isRequired":true,"uniqueKey":"generated_code.status","typeLabel":"enum\u003cstring>"},"type":{"description":"Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration.","enum":["time_bound","ongoing"],"type":"string","isRequired":true,"uniqueKey":"generated_code.type","typeLabel":"enum\u003cstring>"},"warnings":{"type":"array","description":"Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).","items":{"type":"object","properties":{"error_code":{"type":"string","description":"Error or warning code.","uniqueKey":"generated_code.warnings.items.[INDEX].error_code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description.","uniqueKey":"generated_code.warnings.items.[INDEX].message","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"When this error or warning was generated.","uniqueKey":"generated_code.warnings.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"generated_code.warnings.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"generated_code.warnings","typeLabel":"object[]"},"workspace_id":{"description":"Unique identifier for the Seam workspace associated with the access code.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"generated_code.workspace_id","typeLabel":"string\u003cuuid>"},"dormakaba_oracode_metadata":{"oneOf":[{"description":"Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices.","properties":{"is_cancellable":{"description":"Indicates whether the stay can be cancelled via the Dormakaba Oracode API.","type":"boolean","uniqueKey":"generated_code.dormakaba_oracode_metadata.oneOf.0.is_cancellable","typeLabel":"boolean"},"is_early_checkin_able":{"description":"Indicates whether early check-in is available for this stay.","type":"boolean","uniqueKey":"generated_code.dormakaba_oracode_metadata.oneOf.0.is_early_checkin_able","typeLabel":"boolean"},"is_extendable":{"description":"Indicates whether the stay can be extended via the Dormakaba Oracode API.","type":"boolean","uniqueKey":"generated_code.dormakaba_oracode_metadata.oneOf.0.is_extendable","typeLabel":"boolean"},"is_overridable":{"description":"Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached.","type":"boolean","uniqueKey":"generated_code.dormakaba_oracode_metadata.oneOf.0.is_overridable","typeLabel":"boolean"},"site_name":{"description":"Dormakaba Oracode site name associated with this access code.","type":"string","uniqueKey":"generated_code.dormakaba_oracode_metadata.oneOf.0.site_name","typeLabel":"string"},"stay_id":{"description":"Dormakaba Oracode stay ID associated with this access code.","format":"float","type":"number","uniqueKey":"generated_code.dormakaba_oracode_metadata.oneOf.0.stay_id","typeLabel":"number\u003cfloat>"},"user_level_id":{"description":"Dormakaba Oracode user level ID associated with this access code.","type":"string","uniqueKey":"generated_code.dormakaba_oracode_metadata.oneOf.0.user_level_id","typeLabel":"string"},"user_level_name":{"oneOf":[{"description":"Dormakaba Oracode user level name associated with this access code.","type":"string","uniqueKey":"generated_code.dormakaba_oracode_metadata.oneOf.0.user_level_name.oneOf.0","typeLabel":"string"},{"description":"Dormakaba Oracode user level name associated with this access code.","type":"null","uniqueKey":"generated_code.dormakaba_oracode_metadata.oneOf.0.user_level_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"generated_code.dormakaba_oracode_metadata.oneOf.0.user_level_name","typeLabel":"string | null"}},"type":"object","uniqueKey":"generated_code.dormakaba_oracode_metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices.","properties":{"is_cancellable":{"description":"Indicates whether the stay can be cancelled via the Dormakaba Oracode API.","type":"boolean"},"is_early_checkin_able":{"description":"Indicates whether early check-in is available for this stay.","type":"boolean"},"is_extendable":{"description":"Indicates whether the stay can be extended via the Dormakaba Oracode API.","type":"boolean"},"is_overridable":{"description":"Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached.","type":"boolean"},"site_name":{"description":"Dormakaba Oracode site name associated with this access code.","type":"string"},"stay_id":{"description":"Dormakaba Oracode stay ID associated with this access code.","format":"float","type":"number"},"user_level_id":{"description":"Dormakaba Oracode user level ID associated with this access code.","type":"string"},"user_level_name":{"oneOf":[{"description":"Dormakaba Oracode user level name associated with this access code.","type":"string"},{"description":"Dormakaba Oracode user level name associated with this access code.","type":"null"}]}},"type":"null","uniqueKey":"generated_code.dormakaba_oracode_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"generated_code.dormakaba_oracode_metadata","typeLabel":"object | null"},"ends_at":{"oneOf":[{"description":"Date and time after which the time-bound access code becomes inactive.","format":"date-time","type":"string","uniqueKey":"generated_code.ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Date and time after which the time-bound access code becomes inactive.","format":"date-time","type":"null","uniqueKey":"generated_code.ends_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"generated_code.ends_at","typeLabel":"string\u003cdate-time> | null"},"is_backup":{"description":"Indicates whether the access code is a backup code.","type":"boolean","uniqueKey":"generated_code.is_backup","typeLabel":"boolean"},"is_scheduled_on_device":{"description":"Indicates whether the code is set on the device according to a preconfigured schedule.","type":"boolean","uniqueKey":"generated_code.is_scheduled_on_device","typeLabel":"boolean"},"is_waiting_for_code_assignment":{"description":"Indicates whether the access code is waiting for a code assignment.","type":"boolean","uniqueKey":"generated_code.is_waiting_for_code_assignment","typeLabel":"boolean"},"pulled_backup_access_code_id":{"oneOf":[{"description":"Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.","format":"uuid","type":"string","uniqueKey":"generated_code.pulled_backup_access_code_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.","format":"uuid","type":"null","uniqueKey":"generated_code.pulled_backup_access_code_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"generated_code.pulled_backup_access_code_id","typeLabel":"string\u003cuuid> | null"},"starts_at":{"oneOf":[{"description":"Date and time at which the time-bound access code becomes active.","format":"date-time","type":"string","uniqueKey":"generated_code.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Date and time at which the time-bound access code becomes active.","format":"date-time","type":"null","uniqueKey":"generated_code.starts_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"generated_code.starts_at","typeLabel":"string\u003cdate-time> | null"}},"required":["workspace_id","common_code_key","type","access_code_id","device_id","name","code","created_at","errors","warnings","is_managed","status","display_status","is_backup_access_code_available","is_external_modification_allowed","is_one_time_use","is_offline_access_code","pending_mutations"],"type":"object","x-route-path":"/access_codes","isRequired":true,"uniqueKey":"generated_code","typeLabel":"object"}},"required":["generated_code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"generated_code":{"access_code_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","code":"\u003cstring>","common_code_key":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","device_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","display_status":"\u003cstring>","errors":[{"error_code":"\u003cstring>","message":"\u003cstring>","created_at":"2023-11-07T05:31:56Z"}],"is_backup_access_code_available":true,"is_external_modification_allowed":true,"is_managed":true,"is_offline_access_code":true,"is_one_time_use":true,"name":"\u003cstring>","pending_mutations":[{"created_at":"2023-11-07T05:31:56Z","message":"\u003cstring>","mutation_code":"creating"}],"status":"setting","type":"time_bound","warnings":[{"error_code":"\u003cstring>","message":"\u003cstring>","created_at":"2023-11-07T05:31:56Z"}],"workspace_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dormakaba_oracode_metadata":{"is_cancellable":true,"is_early_checkin_able":true,"is_extendable":true,"is_overridable":true,"site_name":"\u003cstring>","stay_id":123,"user_level_id":"\u003cstring>","user_level_name":"\u003cstring>"},"ends_at":"2023-11-07T05:31:56Z","is_backup":true,"is_scheduled_on_device":true,"is_waiting_for_code_assignment":true,"pulled_backup_access_code_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","starts_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"description":"OK","exampleType":"generated"},"b7790030-77ca-4dbe-bbc6-86828a43b757":{"description":"Bad Request","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"ccea74c3-15eb-43d4-be21-771a15c5720e":{"description":"Unauthorized","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"92b9c228-a3cf-4f7e-9fe2-ade55656c352":{"client_session":{"bearerFormat":"Client Session Token","scheme":"bearer","type":"http","scopes":[],"schemeName":"client_session"}},"d93ea0cb-83e8-433f-9c08-42cf55e4f12c":{"pat_with_workspace":{"bearerFormat":"API Token","scheme":"bearer","type":"http","scopes":[],"schemeName":"pat_with_workspace"}},"04624ef0-b8ce-4d00-95a4-9c8e1707d594":{"console_session_with_workspace":{"bearerFormat":"Console Session Token","scheme":"bearer","type":"http","scopes":[],"schemeName":"console_session_with_workspace"}},"a695a2bb-fa1c-4051-99b9-453ee0dc4af5":{"api_key":{"bearerFormat":"API Key","scheme":"bearer","type":"http","scopes":[],"schemeName":"api_key"}},"8ec49bd6-8919-4058-ae09-18c4ecf38cad":{"support_read_only_token":{"bearerFormat":"Support Read-Only Token","scheme":"bearer","type":"http","scopes":[],"schemeName":"support_read_only_token"}}},"servers":{"b50d4898-2dfb-42da-9d6d-a891d229f9f8":{"url":"https://connect.getseam.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"Client Session Token","scheme":"bearer","type":"http","scopes":[],"schemeName":"client_session"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"client_session","name":"Authorization"}],"title":"client_session"},{"schemes":[{"scheme":{"bearerFormat":"API Token","scheme":"bearer","type":"http","scopes":[],"schemeName":"pat_with_workspace"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"pat_with_workspace","name":"Authorization"}],"title":"pat_with_workspace"},{"schemes":[{"scheme":{"bearerFormat":"Console Session Token","scheme":"bearer","type":"http","scopes":[],"schemeName":"console_session_with_workspace"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"console_session_with_workspace","name":"Authorization"}],"title":"console_session_with_workspace"},{"schemes":[{"scheme":{"bearerFormat":"API Key","scheme":"bearer","type":"http","scopes":[],"schemeName":"api_key"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"api_key","name":"Authorization"}],"title":"api_key"},{"schemes":[{"scheme":{"bearerFormat":"Support Read-Only Token","scheme":"bearer","type":"http","scopes":[],"schemeName":"support_read_only_token"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"support_read_only_token","name":"Authorization"}],"title":"support_read_only_token"}]},"originalFileLocation":"openapi.json"},"subdomain":"seam","siteName":"Seam","title":"Generate a Code - Seam","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-24T23:39:07.083Z","originalFileLocation":"api/access_codes/generate_code.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=\"Generates a code for an access code, given a device ID. Reference for GET /access_codes/generate_code in the Seam API, with request and response details.\">\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=\"Generate a Code - Seam\">\u003cmeta data-mint-head property=\"og:description\" content=\"Generates a code for an access code, given a device ID. Reference for GET /access_codes/generate_code in the Seam API, with request and response details.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Seam\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.seam.co/docs/api/access_codes/generate_code\">\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=\"Generate a Code - Seam\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Generates a code for an access code, given a device ID. Reference for GET /access_codes/generate_code in the Seam API, with request and response details.\">\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/access_codes/generate_code\">\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/access_codes/generate_code.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/access_codes/generate_code#webpage\",\"url\":\"https://www.seam.co/docs/api/access_codes/generate_code\",\"name\":\"Generate a Code\",\"description\":\"Generates a code for an access code, given a device ID. Reference for GET /access_codes/generate_code in the Seam API, with request and response details.\",\"dateModified\":\"2026-10-24T23:39:07.083Z\",\"isPartOf\":{\"@id\":\"https://www.seam.co/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.seam.co/docs/api/access_codes/generate_code#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.seam.co/docs/api/access_codes/generate_code#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\":\"Access Codes\",\"item\":\"https://www.seam.co/docs/api/access_codes/object\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Generate a Code\",\"item\":\"https://www.seam.co/docs/api/access_codes/generate_code\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.seam.co/docs/api/access_codes/generate_code#apireference\",\"headline\":\"Generate a Code\",\"name\":\"Generate a Code\",\"description\":\"Generates a code for an access code, given a device ID. Reference for GET /access_codes/generate_code in the Seam API, with request and response details.\",\"url\":\"https://www.seam.co/docs/api/access_codes/generate_code\",\"mainEntityOfPage\":{\"@id\":\"https://www.seam.co/docs/api/access_codes/generate_code#webpage\"},\"image\":\"https://www.seam.co/docs/images/seam-og-default.jpg\",\"dateModified\":\"2026-10-24T23:39:07.083Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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"}]},{"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":"Delete an Access Grant","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /access_grants/delete","href":"/api/access_grants/delete"},{"title":"Get an Access Grant","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /access_grants/get","href":"/api/access_grants/get"},{"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":"List Access Grants","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /access_grants/list","href":"/api/access_grants/list"},{"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"},{"title":"Create an Access Grant","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /access_grants/create","href":"/api/access_grants/create"},{"title":"Update an Access Grant","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /access_grants/update","href":"/api/access_grants/update"},{"title":"Delete an Access Grant","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /access_grants/delete","href":"/api/access_grants/delete"},{"title":"Get an Access Grant","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /access_grants/get","href":"/api/access_grants/get"},{"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":"List Access Grants","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /access_grants/list","href":"/api/access_grants/list"},{"title":"Update an Access Grant","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /access_grants/update","href":"/api/access_grants/update"},{"group":"Unmanaged","pages":[{"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":"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":"Delete an Access Method","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /access_methods/delete","href":"/api/access_methods/delete"},{"title":"Delete an Access Method","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /access_methods/delete","href":"/api/access_methods/delete"},{"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 an Access Method","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /access_methods/get","href":"/api/access_methods/get"},{"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":"List Access Methods","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /access_methods/list","href":"/api/access_methods/list"},{"title":"Get an Access Method","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /access_methods/get","href":"/api/access_methods/get"},{"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":"List Access Methods","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /access_methods/list","href":"/api/access_methods/list"},{"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":"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 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":"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"},{"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 Device Disconnection","deprecated":null,"version":null,"sidebarTitle":"Disconnect","openapi":"/openapi.json post /devices/simulate/disconnect","href":"/api/devices/simulate/disconnect"},{"title":"Simulate Device Removal","deprecated":null,"version":null,"sidebarTitle":"Remove","openapi":"/openapi.json post /devices/simulate/remove","href":"/api/devices/simulate/remove"},{"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 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"}]},{"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"}]},{"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":"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"},{"title":"Update a Device","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /devices/update","href":"/api/devices/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":"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":"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":"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"}]},{"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"}]},{"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":"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":"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":"List Thermostats","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /thermostats/list","href":"/api/thermostats/list"},{"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":"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":"List Thermostats","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /thermostats/list","href":"/api/thermostats/list"},{"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 to Cool Mode","deprecated":null,"version":null,"sidebarTitle":"Cool","openapi":"/openapi.json post /thermostats/cool","href":"/api/thermostats/cool"},{"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":"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":"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"},{"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":"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":"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":"Update a Thermostat Schedule","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /thermostats/schedules/update","href":"/api/thermostats/schedules/update"},{"title":"Delete a Thermostat Schedule","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /thermostats/schedules/delete","href":"/api/thermostats/schedules/delete"},{"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":"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":"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":"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":"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":"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":"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"},{"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":"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":"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":"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":"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":"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":"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":"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"},{"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"}]},{"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":"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":"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":"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":"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 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":"List ACS Users","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /acs/users/list","href":"/api/acs/users/list"},{"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":"Delete an ACS User","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /acs/users/delete","href":"/api/acs/users/delete"},{"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":"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"},{"title":"Update an ACS User","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /acs/users/update","href":"/api/acs/users/update"},{"title":"Update an ACS User","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /acs/users/update","href":"/api/acs/users/update"}]},{"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":"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":"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":"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":"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":"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"},{"title":"Update a Credential","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /acs/credentials/update","href":"/api/acs/credentials/update"},{"title":"Delete a Credential","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /acs/credentials/delete","href":"/api/acs/credentials/delete"},{"title":"Get a Credential","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /acs/credentials/get","href":"/api/acs/credentials/get"},{"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":"List Credentials","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /acs/credentials/list","href":"/api/acs/credentials/list"},{"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"},{"title":"Update a Credential","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /acs/credentials/update","href":"/api/acs/credentials/update"}]},{"group":"Encoders","pages":[{"title":"The Encoder Object","href":"/api/acs/encoders/object"},{"title":"Encoder Events","href":"/api/acs/encoders/events"},{"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":"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":"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":"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"},{"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":"Get an Entrance","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /acs/entrances/get","href":"/api/acs/entrances/get"},{"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":"List Entrances","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /acs/entrances/list","href":"/api/acs/entrances/list"},{"title":"List Entrances","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /acs/entrances/list","href":"/api/acs/entrances/list"},{"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":"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":"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"},{"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":"Delete a Connect Webview","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /connect_webviews/delete","href":"/api/connect_webviews/delete"},{"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"}]},{"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":"Delete a Connected Account","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /connected_accounts/delete","href":"/api/connected_accounts/delete"},{"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":"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":"Sync a Connected Account","deprecated":null,"version":null,"sidebarTitle":"Sync","openapi":"/openapi.json post /connected_accounts/sync","href":"/api/connected_accounts/sync"},{"title":"Update a Connected Account","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /connected_accounts/update","href":"/api/connected_accounts/update"},{"title":"Update a Connected Account","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /connected_accounts/update","href":"/api/connected_accounts/update"},{"group":"Simulations","pages":[{"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":"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":"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":"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":"Delete a User Identity","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /user_identities/delete","href":"/api/user_identities/delete"},{"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":"Get a User Identity","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /user_identities/get","href":"/api/user_identities/get"},{"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 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":"List User Identities","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /user_identities/list","href":"/api/user_identities/list"},{"title":"Get a User Identity","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /user_identities/get","href":"/api/user_identities/get"},{"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 User Identities","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /user_identities/list","href":"/api/user_identities/list"},{"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"},{"title":"Update a User Identity","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /user_identities/update","href":"/api/user_identities/update"},{"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"},{"title":"Update a User Identity","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /user_identities/update","href":"/api/user_identities/update"},{"group":"Unmanaged","pages":[{"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"}]},{"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"}]},{"group":"Workspaces","pages":[{"title":"The Workspace Object","href":"/api/workspaces/object"},{"title":"Create a Workspace","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /workspaces/create","href":"/api/workspaces/create"},{"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":"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":"Reset a Sandbox Workspace","deprecated":null,"version":null,"sidebarTitle":"Reset sandbox","openapi":"/openapi.json post /workspaces/reset_sandbox","href":"/api/workspaces/reset_sandbox"},{"title":"Update a Workspace","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /workspaces/update","href":"/api/workspaces/update"},{"title":"Update a Workspace","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /workspaces/update","href":"/api/workspaces/update"}]},{"group":"Client Sessions","pages":[{"title":"The Client Session Object","href":"/api/client_sessions/object"},{"title":"Client Session Events","href":"/api/client_sessions/events"},{"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 a Client Session","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /client_sessions/get","href":"/api/client_sessions/get"},{"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 a Client Session","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /client_sessions/get","href":"/api/client_sessions/get"},{"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":"List Client Sessions","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /client_sessions/list","href":"/api/client_sessions/list"},{"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":"List Client Sessions","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /client_sessions/list","href":"/api/client_sessions/list"},{"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":"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":"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":"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 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":"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":"Get a Space","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /spaces/get","href":"/api/spaces/get"},{"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":"List Spaces","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /spaces/list","href":"/api/spaces/list"},{"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"},{"title":"Update a Space","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /spaces/update","href":"/api/spaces/update"},{"title":"Delete a Space","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /spaces/delete","href":"/api/spaces/delete"},{"title":"Get a Space","deprecated":null,"version":null,"sidebarTitle":"Get","openapi":"/openapi.json get /spaces/get","href":"/api/spaces/get"},{"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":"List Spaces","deprecated":null,"version":null,"sidebarTitle":"List","openapi":"/openapi.json get /spaces/list","href":"/api/spaces/list"},{"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"},{"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":"Update a Space","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /spaces/update","href":"/api/spaces/update"}]}]},{"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":"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":"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":"Update a Webhook","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json put /webhooks/update","href":"/api/webhooks/update"},{"title":"Delete a Webhook","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /webhooks/delete","href":"/api/webhooks/delete"},{"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":"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":"Create an Access Code","deprecated":null,"version":null,"sidebarTitle":"Create","openapi":"/openapi.json post /access_codes/create","href":"/api/access_codes/create"},{"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":"Delete an Access Code","description":"Deletes an access code. Reference for DELETE /access_codes/delete in the Seam API, with request and response details.","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /access_codes/delete","href":"/api/access_codes/delete"},{"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":"Get an Access Code","description":"Returns a specified [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.\n\nYou must include at least one request parameter.","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 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":"Delete an Access Code","description":"Deletes an access code. Reference for DELETE /access_codes/delete in the Seam API, with request and response details.","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /access_codes/delete","href":"/api/access_codes/delete"},{"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":"Get an Access Code","description":"Returns a specified [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.\n\nYou must include at least one request parameter.","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":"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 an Access Code","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /access_codes/update","href":"/api/access_codes/update"},{"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"},{"title":"Update an Access Code","deprecated":null,"version":null,"sidebarTitle":"Update","openapi":"/openapi.json patch /access_codes/update","href":"/api/access_codes/update"},{"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":"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":"Convert an Unmanaged Access Code","deprecated":null,"version":null,"sidebarTitle":"Convert to managed","openapi":"/openapi.json patch /access_codes/unmanaged/convert_to_managed","href":"/api/access_codes/unmanaged/convert_to_managed"},{"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":"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":"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"}]}]},{"group":"Phones","pages":[{"title":"The Phone Object","href":"/api/phones/object"},{"title":"Phone Events","href":"/api/phones/events"},{"title":"Phone Errors and Warnings","href":"/api/phones/errors"},{"title":"Deactivate a Phone","deprecated":null,"version":null,"sidebarTitle":"Deactivate","openapi":"/openapi.json delete /phones/deactivate","href":"/api/phones/deactivate"},{"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"},{"group":"Simulations","pages":[{"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":"Delete an Instant Key","deprecated":null,"version":null,"sidebarTitle":"Delete","openapi":"/openapi.json delete /instant_keys/delete","href":"/api/instant_keys/delete"},{"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"}]}]}]},{"tab":"Mobile SDKs","pages":[{"title":"Mobile SDKs","href":"/mobile-sdks"}]},{"tab":"Brand Guides","pages":[{"title":"Brand Guides","href":"/device-and-system-integration-guides"}]}]},"title":"Generate a Code - Seam","buildId":"dpl_3DJU2xKhT5gDPFQL5Tqv7AFnkWsF","deploymentId":"dpl_3DJU2xKhT5gDPFQL5Tqv7AFnkWsF","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DsGgv5pK.js","utils-B0h6ZXi-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-IgrnFwPw.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C49-TBER.js","snippetPresets-BPHn-9OB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CGBwAHwX.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BjABHCCH.js","shallow-C0Uj5sOI.js","getApiPlaygroundDisplay-BnYiIeY4.js","CodeSnippet-BJWWrlBw.js","CodeSnippets-bxE5aDye.js","Page-BBU7roUf.js","getPastedJson-BAjriezQ.js","icon-BqcS52QC.js","MethodPill-BPGyN9me.js","DuplicateIcon-CCf2giLL.js","createIcon-CVH8aNt2.js","DynamicMarkdown-BklwmxA6.js","SectionHeading-DYCZQFxh.js","axios-vUo_bRtp.js","Markdown-D26rHnOC.js","clsx-DkiOUx4h.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DI8jfVGc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DwJy-csb.js"]}