Send your API key in the x-api-key header of every request. The key belongs to one Orbital account, and requests act as that account: they see and control only the devices it owns or has been given access to. A missing or unknown key gets 403 with { "message": "Forbidden" }.
Lets someone ask for access when they try to pair a device you own. When off, they get 403 with code1.
Example:
true
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Orbital","colors":{"primary":"#ff5500","light":"#ff5500","dark":"#ff5500"},"logo":{"light":"https://mintcdn.com/orbitalsystems/EVkTDln8Sf7ZkRWS/logo/light.svg?fit=max\u0026auto=format\u0026n=EVkTDln8Sf7ZkRWS\u0026q=85\u0026s=3a37dd35c2861055878486ade93d7855","dark":"https://mintcdn.com/orbitalsystems/EVkTDln8Sf7ZkRWS/logo/dark.svg?fit=max\u0026auto=format\u0026n=EVkTDln8Sf7ZkRWS\u0026q=85\u0026s=7cdb628407f2b5eb8cad3278c77e461d"},"favicon":"https://mintcdn.com/orbitalsystems/EVkTDln8Sf7ZkRWS/favicon.svg?fit=max\u0026auto=format\u0026n=EVkTDln8Sf7ZkRWS\u0026q=85\u0026s=b0f03da03d835fd4176e3735b94604f7","navbar":{"links":[{"href":"mailto:support@orbital-systems.com","label":"Support"}]},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/orbital-systems","linkedin":"https://linkedin.com/company/orbital-systems"}},"fonts":{"family":"Inter Tight","source":"https://fonts.googleapis.com/css2?family=Inter+Tight:ital,wght@0,100..900;1,100..900\u0026display=swap","format":"woff2"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"orbitalsystems","hasAudioNarration":false,"actualSubdomain":"orbitalsystems","customDomains":["docs.orbital-systems.com"],"gitSource":{"type":"github","owner":"orbital-systems","repo":"odp","deployBranch":"master","contentDirectory":"packages/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aeb04da68099c0da064e62b","collectionId":"d52a3434-51a8-4b4f-9809-4e87116e6037","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeb04da68099c0da064e62b"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6aeb04da68099c0da064e62b","clientVersion":"0.0.4071","searchFilterCounts":[{"language":"default","tag":"API","count":43},{"language":"default","tag":"Groups.","count":5},{"language":"default","tag":"User invites.","count":5},{"language":"default","tag":"History.","count":3},{"language":"default","tag":"Shower configuration.","count":3},{"language":"default","tag":"Shower installation.","count":3},{"language":"default","tag":"Showers.","count":3},{"language":"default","tag":"Tap configuration.","count":3},{"language":"default","tag":"Taps.","count":3},{"language":"default","tag":"User.","count":3}]},"assistantConfig":{},"basePath":"","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/user/get-user","slug":"/api-reference/user/get-user","pageMetadata":{"title":"Get user","description":null,"deprecated":null,"version":null,"openapi":"/spec.json get /client/user","href":"/api-reference/user/get-user","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":{"config":{},"pageMetadata":{"title":"Get user","description":null,"deprecated":null,"version":null,"openapi":"/spec.json get /client/user","href":"/api-reference/user/get-user","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["User."],"summary":"Get user","responses":{"200":"fd3bc950-d79b-4bb9-a304-114586b17acd","500":"7a54df8a-7b20-4b1b-9e79-dc56c69b7cb2"},"method":"get","type":"path","servers":["bdfec3b1-a639-42c1-ae6a-df78d7049378","d74f0656-3d54-4220-9034-0a05241656b8","56b66090-3d89-4803-bdf1-c93f775d7407"],"security":["e916a54d-4680-4b7b-9d96-81d36f47e05b"],"path":"/client/user","baseUrlOptions":["https://api.orbital-systems.com","https://stage-api.orbital-systems.com","https://dev-api.orbital-systems.com"],"title":"Get user","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"fd3bc950-d79b-4bb9-a304-114586b17acd":{"description":"User details retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the user.","example":"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b","uniqueKey":"id","typeLabel":"string"},"group_id":{"type":"string","description":"ID of the group your account belongs to.","example":"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b","uniqueKey":"group_id","typeLabel":"string"},"address":{"type":"object","properties":{"city":{"type":"string","description":"City.","example":"Gothenburg","uniqueKey":"address.city","typeLabel":"string"},"country":{"type":"string","description":"Country.","example":"Sweden","uniqueKey":"address.country","typeLabel":"string"},"street":{"type":"string","description":"Street address.","example":"Exempelgatan 1","uniqueKey":"address.street","typeLabel":"string"},"zip_code":{"type":"string","description":"Postal code.","example":"411 01","uniqueKey":"address.zip_code","typeLabel":"string"}},"description":"Postal address.","uniqueKey":"address","typeLabel":"object"},"company":{"type":"string","description":"Company name.","example":"Orbital Systems","uniqueKey":"company","typeLabel":"string"},"email":{"type":"string","description":"Email address the user signs in with.","example":"alex@example.com","uniqueKey":"email","typeLabel":"string"},"firstname":{"type":"string","description":"First name.","example":"Alex","uniqueKey":"firstname","typeLabel":"string"},"lastname":{"type":"string","description":"Last name.","example":"Andersson","uniqueKey":"lastname","typeLabel":"string"},"notification_app":{"type":"boolean","description":"Sends notifications to the Orbital app.","example":true,"uniqueKey":"notification_app","typeLabel":"boolean"},"notification_email":{"type":"boolean","description":"Sends notifications by email.","example":false,"uniqueKey":"notification_email","typeLabel":"boolean"},"notification_interval":{"oneOf":[{"type":"string","enum":["daily","weekly"],"description":"Collects non-urgent notifications into a `daily` or `weekly` summary. `null` sends each one as it happens.","example":null,"uniqueKey":"notification_interval.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["daily","weekly"],"description":"Collects non-urgent notifications into a `daily` or `weekly` summary. `null` sends each one as it happens.","example":null,"uniqueKey":"notification_interval.oneOf.1","typeLabel":"null"}],"uniqueKey":"notification_interval","typeLabel":"enum\u003cstring> | null"},"phone_number":{"type":"string","description":"Phone number.","example":"+46701234567","uniqueKey":"phone_number","typeLabel":"string"},"volume_unit":{"type":"string","enum":["litre","gallon"],"description":"Volume unit shown in the app: `litre` or `gallon`.","example":"litre","uniqueKey":"volume_unit","typeLabel":"enum\u003cstring>"},"temperature_unit":{"type":"string","enum":["celsius","fahrenheit"],"description":"Temperature unit shown in the app: `celsius` or `fahrenheit`.","example":"celsius","uniqueKey":"temperature_unit","typeLabel":"enum\u003cstring>"},"consent":{"type":"boolean","description":"Stored for the Orbital app; the API doesn’t act on it.","example":true,"uniqueKey":"consent","typeLabel":"boolean"},"google_home":{"type":"boolean","description":"Whether Google Home is linked to the account.","example":false,"uniqueKey":"google_home","typeLabel":"boolean"},"alexa":{"type":"boolean","description":"Whether Alexa has been linked to the account.","example":false,"uniqueKey":"alexa","typeLabel":"boolean"},"dark_theme":{"type":"boolean","description":"Stored for the Orbital app; the API doesn’t act on it.","example":false,"uniqueKey":"dark_theme","typeLabel":"boolean"},"use_phone_theme":{"type":"boolean","description":"Stored for the Orbital app; the API doesn’t act on it.","example":true,"uniqueKey":"use_phone_theme","typeLabel":"boolean"},"updated_at":{"type":"string","description":"When the record was last changed (ISO 8601).","example":"2026-10-28T17:03:10.000Z","uniqueKey":"updated_at","typeLabel":"string"},"automatic_timezone":{"type":"boolean","description":"Stored for the Orbital app; the API doesn’t act on it.","example":true,"uniqueKey":"automatic_timezone","typeLabel":"boolean"},"locale":{"type":"string","description":"Language code for emails and push notifications. Defaults to `en`.","example":"en","uniqueKey":"locale","typeLabel":"string"},"sharing_requests":{"type":"boolean","description":"Lets someone ask for access when they try to pair a device you own. When off, they get `403` with `code` `1`.","example":true,"uniqueKey":"sharing_requests","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b","group_id":"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b","address":{"city":"Gothenburg","country":"Sweden","street":"Exempelgatan 1","zip_code":"411 01"},"company":"Orbital Systems","email":"alex@example.com","firstname":"Alex","lastname":"Andersson","notification_app":true,"notification_email":false,"notification_interval":null,"phone_number":"+46701234567","volume_unit":"litre","temperature_unit":"celsius","consent":true,"google_home":false,"alexa":false,"dark_theme":false,"use_phone_theme":true,"updated_at":"2026-10-28T17:03:10.000Z","automatic_timezone":true,"locale":"en","sharing_requests":true}}},"exampleType":"generated"}},"exampleType":"generated"},"7a54df8a-7b20-4b1b-9e79-dc56c69b7cb2":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"Returned with every 4xx and 5xx response.","required":["message"],"properties":{"message":{"type":"string","description":"What went wrong.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"name":{"type":"string","description":"Kind of error. Not set on a `500`.","uniqueKey":"name","typeLabel":"string"},"statusCode":{"type":"integer","description":"HTTP status code, repeated from the response. Not set on a `500`.","uniqueKey":"statusCode","typeLabel":"integer"},"code":{"type":"integer","enum":[1,2],"description":"Set on a `403` from pairing a device someone else owns: `1` the owner doesn’t accept sharing requests, `2` a sharing request was sent to the owner.","uniqueKey":"code","typeLabel":"enum\u003cinteger>"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Internal server error"},"examples":{"Example":{"title":"Example","value":{"message":"Internal server error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e916a54d-4680-4b7b-9d96-81d36f47e05b":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Send your API key in the `x-api-key` header of every request. The key belongs to one Orbital account, and requests act as that account: they see and control only the devices it owns or has been given access to. A missing or unknown key gets `403` with `{ \"message\": \"Forbidden\" }`.","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"bdfec3b1-a639-42c1-ae6a-df78d7049378":{"url":"https://api.orbital-systems.com","description":"Production"},"d74f0656-3d54-4220-9034-0a05241656b8":{"url":"https://stage-api.orbital-systems.com","description":"Staging"},"56b66090-3d89-4803-bdf1-c93f775d7407":{"url":"https://dev-api.orbital-systems.com","description":"Development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Send your API key in the `x-api-key` header of every request. The key belongs to one Orbital account, and requests act as that account: they see and control only the devices it owns or has been given access to. A missing or unknown key gets `403` with `{ \"message\": \"Forbidden\" }`.","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"Send your API key in the `x-api-key` header of every request. The key belongs to one Orbital account, and requests act as that account: they see and control only the devices it owns or has been given access to. A missing or unknown key gets `403` with `{ \"message\": \"Forbidden\" }`.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"x-api-key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"spec.json"},"subdomain":"orbitalsystems","siteName":"Orbital","title":"Get user - Orbital","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-04T10:11:43.970Z","originalFileLocation":"api-reference/user/get-user.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=\"application-name\" content=\"Orbital\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orbitalsystems/9Vm0PDYjg65a0uU4/_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=\"/mintlify-assets/_mintlify/favicons/orbitalsystems/9Vm0PDYjg65a0uU4/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orbitalsystems/9Vm0PDYjg65a0uU4/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/orbitalsystems/9Vm0PDYjg65a0uU4/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/orbitalsystems/9Vm0PDYjg65a0uU4/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orbitalsystems/9Vm0PDYjg65a0uU4/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orbitalsystems/9Vm0PDYjg65a0uU4/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/orbitalsystems/9Vm0PDYjg65a0uU4/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/orbitalsystems/9Vm0PDYjg65a0uU4/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get user - Orbital\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Orbital\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.orbital-systems.com/api-reference/user/get-user\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orbitalsystems.mintlify.app/_mintlify/api/og/v2?division=User.\u0026amp;title=Get+user\u0026amp;theme=29f26c9e5f1199e6c6570a2b\u0026amp;signature=87c65657261d4e9159951c42ecdfa4b75ffcaefc869b82ac22fa74794f333681\">\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=\"Get user - Orbital\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orbitalsystems.mintlify.app/_mintlify/api/og/v2?division=User.\u0026amp;title=Get+user\u0026amp;theme=29f26c9e5f1199e6c6570a2b\u0026amp;signature=87c65657261d4e9159951c42ecdfa4b75ffcaefc869b82ac22fa74794f333681\">\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=\"/mintlify-assets/_mintlify/favicons/orbitalsystems/9Vm0PDYjg65a0uU4/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Orbital\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff5500\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.orbital-systems.com/api-reference/user/get-user\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/user/get-user.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.orbital-systems.com/#organization\",\"name\":\"Orbital\",\"url\":\"https://docs.orbital-systems.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/orbitalsystems/EVkTDln8Sf7ZkRWS/logo/light.svg?fit=max\u0026auto=format\u0026n=EVkTDln8Sf7ZkRWS\u0026q=85\u0026s=3a37dd35c2861055878486ade93d7855\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.orbital-systems.com#website\",\"name\":\"Orbital\",\"url\":\"https://docs.orbital-systems.com\",\"publisher\":{\"@id\":\"https://docs.orbital-systems.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.orbital-systems.com/api-reference/user/get-user#webpage\",\"url\":\"https://docs.orbital-systems.com/api-reference/user/get-user\",\"name\":\"Get user\",\"dateModified\":\"2026-11-04T10:11:43.970Z\",\"isPartOf\":{\"@id\":\"https://docs.orbital-systems.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.orbital-systems.com/api-reference/user/get-user#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.orbital-systems.com/api-reference/user/get-user#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Orbital\",\"item\":\"https://docs.orbital-systems.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get user\",\"item\":\"https://docs.orbital-systems.com/api-reference/user/get-user\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.orbital-systems.com/api-reference/user/get-user#apireference\",\"headline\":\"Get user\",\"name\":\"Get user\",\"url\":\"https://docs.orbital-systems.com/api-reference/user/get-user\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orbital-systems.com/api-reference/user/get-user#webpage\"},\"dateModified\":\"2026-11-04T10:11:43.970Z\",\"publisher\":{\"@id\":\"https://docs.orbital-systems.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.orbital-systems.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Orbital\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Orbital","nav":{"global":null,"anchors":[{"anchor":"API","icon":"square-terminal","groups":[{"group":"Groups.","pages":[{"title":"Get group","deprecated":null,"version":null,"openapi":"/spec.json get /client/groups/{id}","href":"/api-reference/groups/get-group"},{"title":"Update group","deprecated":null,"version":null,"openapi":"/spec.json put /client/groups/{id}","href":"/api-reference/groups/update-group"},{"title":"Delete group","deprecated":null,"version":null,"openapi":"/spec.json delete /client/groups/{id}","href":"/api-reference/groups/delete-group"},{"title":"List groups","deprecated":null,"version":null,"openapi":"/spec.json get /client/groups","href":"/api-reference/groups/list-groups"},{"title":"Create group","deprecated":null,"version":null,"openapi":"/spec.json post /client/groups","href":"/api-reference/groups/create-group"}]},{"group":"History.","pages":[{"title":"List history by device","deprecated":null,"version":null,"openapi":"/spec.json get /client/history/{id}","href":"/api-reference/history/list-history-by-device"},{"title":"Update history","deprecated":null,"version":null,"openapi":"/spec.json put /client/history/{id}","href":"/api-reference/history/update-history"},{"title":"List history","deprecated":null,"version":null,"openapi":"/spec.json get /client/history","href":"/api-reference/history/list-history"}]},{"group":"History metadata.","pages":[{"title":"Get history metadata","deprecated":null,"version":null,"openapi":"/spec.json get /client/history-metadata/{id}","href":"/api-reference/history-metadata/get-history-metadata"}]},{"group":"User invites.","pages":[{"title":"List user invites","deprecated":null,"version":null,"openapi":"/spec.json get /client/user/invites","href":"/api-reference/user-invites/list-user-invites"},{"title":"Create user invite","deprecated":null,"version":null,"openapi":"/spec.json post /client/user/invites","href":"/api-reference/user-invites/create-user-invite"},{"title":"Get user invite","deprecated":null,"version":null,"openapi":"/spec.json get /client/user/invites/{id}","href":"/api-reference/user-invites/get-user-invite"},{"title":"Update user invite","deprecated":null,"version":null,"openapi":"/spec.json put /client/user/invites/{id}","href":"/api-reference/user-invites/update-user-invite"},{"title":"Delete user invite","deprecated":null,"version":null,"openapi":"/spec.json delete /client/user/invites/{id}","href":"/api-reference/user-invites/delete-user-invite"}]},{"group":"Showers.","pages":[{"title":"Get shower","deprecated":null,"version":null,"openapi":"/spec.json get /client/showers/{id}","href":"/api-reference/showers/get-shower"},{"title":"Update shower","deprecated":null,"version":null,"openapi":"/spec.json put /client/showers/{id}","href":"/api-reference/showers/update-shower"},{"title":"List showers","deprecated":null,"version":null,"openapi":"/spec.json get /client/showers","href":"/api-reference/showers/list-showers"}]},{"group":"Shower pairing.","pages":[{"title":"Unpair shower","deprecated":null,"version":null,"openapi":"/spec.json delete /client/showers/{id}","href":"/api-reference/shower-pairing/unpair-shower"},{"title":"Pair shower","deprecated":null,"version":null,"openapi":"/spec.json put /client/showers/pair/{id}","href":"/api-reference/shower-pairing/pair-shower"}]},{"group":"Shower savings.","pages":[{"title":"Get total savings","deprecated":null,"version":null,"openapi":"/spec.json get /client/showers/savings","href":"/api-reference/shower-savings/get-total-savings"}]},{"group":"Shower commissioning.","pages":[{"title":"Commission shower","deprecated":null,"version":null,"openapi":"/spec.json put /client/showers/commission/{id}","href":"/api-reference/shower-commissioning/commission-shower"}]},{"group":"Shower configuration.","pages":[{"title":"Get configuration","deprecated":null,"version":null,"openapi":"/spec.json get /client/showers/{id}/configuration","href":"/api-reference/shower-configuration/get-configuration"},{"title":"Update configuration","deprecated":null,"version":null,"openapi":"/spec.json put /client/showers/{id}/configuration","href":"/api-reference/shower-configuration/update-configuration"},{"title":"Reset configuration","deprecated":null,"version":null,"openapi":"/spec.json delete /client/showers/{id}/configuration","href":"/api-reference/shower-configuration/reset-configuration"}]},{"group":"Shower instant start schedules.","pages":[{"title":"Get instant start","deprecated":null,"version":null,"openapi":"/spec.json get /client/showers/{id}/instantstart","href":"/api-reference/shower-instant-start-schedules/get-instant-start"},{"title":"Update instant start","deprecated":null,"version":null,"openapi":"/spec.json put /client/showers/{id}/instantstart","href":"/api-reference/shower-instant-start-schedules/update-instant-start"}]},{"group":"Shower installation.","pages":[{"title":"Get installation test","deprecated":null,"version":null,"openapi":"/spec.json get /client/showers/{id}/installation","href":"/api-reference/shower-installation/get-installation-test"},{"title":"Start installation test","deprecated":null,"version":null,"openapi":"/spec.json put /client/showers/{id}/installation","href":"/api-reference/shower-installation/start-installation-test"},{"title":"Abort installation test","deprecated":null,"version":null,"openapi":"/spec.json delete /client/showers/{id}/installation","href":"/api-reference/shower-installation/abort-installation-test"}]},{"group":"Shower commands.","pages":[{"title":"Send a remote control command to a shower","deprecated":null,"version":null,"openapi":"/spec.json post /client/showers/{id}/commands","href":"/api-reference/shower-commands/send-a-remote-control-command-to-a-shower"},{"title":"Get the live status of a shower","deprecated":null,"version":null,"openapi":"/spec.json get /client/showers/{id}/status","href":"/api-reference/shower-commands/get-the-live-status-of-a-shower"}]},{"group":"Taps.","pages":[{"title":"Get tap","deprecated":null,"version":null,"openapi":"/spec.json get /client/taps/{id}","href":"/api-reference/taps/get-tap"},{"title":"Update tap","deprecated":null,"version":null,"openapi":"/spec.json put /client/taps/{id}","href":"/api-reference/taps/update-tap"},{"title":"List taps","deprecated":null,"version":null,"openapi":"/spec.json get /client/taps","href":"/api-reference/taps/list-taps"}]},{"group":"Tap pairing.","pages":[{"title":"Unpair tap","deprecated":null,"version":null,"openapi":"/spec.json delete /client/taps/{id}","href":"/api-reference/tap-pairing/unpair-tap"},{"title":"Pair tap","deprecated":null,"version":null,"openapi":"/spec.json put /client/taps/pair/{id}","href":"/api-reference/tap-pairing/pair-tap"}]},{"group":"Tap configuration.","pages":[{"title":"Get configuration","deprecated":null,"version":null,"openapi":"/spec.json get /client/taps/{id}/configuration","href":"/api-reference/tap-configuration/get-configuration"},{"title":"Update configuration","deprecated":null,"version":null,"openapi":"/spec.json put /client/taps/{id}/configuration","href":"/api-reference/tap-configuration/update-configuration"},{"title":"Reset configuration","deprecated":null,"version":null,"openapi":"/spec.json delete /client/taps/{id}/configuration","href":"/api-reference/tap-configuration/reset-configuration"}]},{"group":"Tap commands.","pages":[{"title":"Send a remote control command to a tap","description":"Waits up to 5 seconds for the tap to accept the command. Accepted means the tap will act on it, not that it already has. The data depends on the action: start takes optional, nullable temperature (°C) and flow (l/min); a missing one is the tap's default_temp or default_flow setting. set_temp takes a required temperature and set_flow a required flow. stop takes none. Setpoints must be within the tap's limits.\n","deprecated":null,"version":null,"openapi":"/spec.json post /client/taps/{id}/commands","href":"/api-reference/tap-commands/send-a-remote-control-command-to-a-tap"}]},{"group":"User.","pages":[{"title":"Get user","deprecated":null,"version":null,"openapi":"/spec.json get /client/user","href":"/api-reference/user/get-user"},{"title":"Update user","description":null,"deprecated":null,"version":null,"openapi":"/spec.json put /client/user","href":"/api-reference/user/update-user"},{"title":"Delete user","deprecated":null,"version":null,"openapi":"/spec.json delete /client/user","href":"/api-reference/user/delete-user"}]}]}]},"basePath":"","title":"Get user - Orbital","buildId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","deploymentId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B5zPa4Vr.js","utils-CVjrr8Yd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DTgURWzl.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DxTHtkdZ.js","snippetPresets-Cx47o5Vx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-4Fr6y9N_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dq2ElbEk.js","shallow-BfYl9r69.js","getApiPlaygroundDisplay-Ch3xc7i1.js","CodeSnippet-BsBxuJ1v.js","CodeSnippets-CetzeDL8.js","Page-CYZot51e.js","getPastedJson-BxPKFSJx.js","icon-o0J1Ochb.js","MethodPill-Du3usO5m.js","DuplicateIcon-DJypyMzl.js","createIcon-YMA6N8KJ.js","DynamicMarkdown-CWvhfcZc.js","SectionHeading-BdLVaXCd.js","axios-vUo_bRtp.js","Markdown-C4Ez6OeV.js","clsx-DptzKFCt.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Dt1IougW.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CZ6Wt2Vb.js"]}