Request production access or ask a question about the SOXAI API.
Request production access
Production-access applications are handled privately. Submit the form below, and we will reply to the email address you provide within 3 business days. Do not include an API key, password, or other secret in your application.
Form responses are processed by Google. Read the privacy policy before submitting personal information. Do not include an API key, password, or other secret in the form.
Ask a question about using the API
For questions about using the API, email info@soxai.co.jp. Usage questions will move to the public API discussions forum when it is available.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SOXAI API Documentation","colors":{"primary":"#1C8C7A","light":"#51B6A6","dark":"#126153"},"api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript"]}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"soxai","hasAudioNarration":false,"actualSubdomain":"soxai","customDomains":["developers.soxai.co.jp"],"gitSource":{"type":"github","owner":"soxaidev","repo":"web-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"}},"buildId":"6af69590f72f7996df871546","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference (Production)","count":69},{"language":"default","tag":"API Reference (Sandbox)","count":69},{"language":"default","tag":"Family Groups","count":34},{"language":"default","tag":"Organization Members","count":24},{"language":"default","tag":"Partner Companies","count":12},{"language":"default","tag":"Data (v2)","count":10},{"language":"default","tag":"OAuth2","count":10},{"language":"default","tag":"Organizations","count":10},{"language":"default","tag":"Authentication","count":8},{"language":"default","tag":"Get started","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"support","slug":"/support","pageMetadata":{"title":"Support","description":"Request production access or ask a question about the SOXAI API.","href":"/support"},"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: \"Request production access or ask a question about the SOXAI API.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Frame,Heading,OptimizedFrame}=_components;if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedFrame)_missingMdxReference(`OptimizedFrame`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`request-production-access`,children:`Request production access`}),`\n`,_jsx(_components.p,{children:`Production-access applications are handled privately. Submit the form below, and we will reply to the email address you provide within 3 business days. Do not include an API key, password, or other secret in your application.`}),`\n`,_jsx(Frame,{children:_jsx(OptimizedFrame,{src:`https://docs.google.com/forms/d/e/1FAIpQLSfMq-B4Jo_TH_vRXUg1joNGjIIH6GBmCk7-DkqAFrg8MtRrcA/viewform?embedded=true`,title:`SOXAI API production access request`,className:`mint-w-full mint-h-[900px] mint-rounded-xl`})}),`\n`,_jsxs(_components.p,{children:[`Form responses are processed by Google. Read the `,_jsx(_components.a,{href:`https://soxai.co.jp/policies/privacy-policy`,children:`privacy policy`}),` before submitting personal information. Do not include an API key, password, or other secret in the form.`]}),`\n`,_jsx(Heading,{level:`2`,id:`ask-a-question-about-using-the-api`,children:`Ask a question about using the API`}),`\n`,_jsxs(_components.p,{children:[`For questions about using the API, email `,_jsx(_components.a,{href:`mailto:info@soxai.co.jp`,children:`info@soxai.co.jp`}),`. Usage questions will move to the public API discussions forum when it is available.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Support","description":"Request production access or ask a question about the SOXAI API.","href":"/support"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Request production access","slug":"request-production-access","depth":2,"children":[]},{"title":"Ask a question about using the API","slug":"ask-a-question-about-using-the-api","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-h-\\[900px\\] {\n height: 900px\n}\n.mint-w-full {\n width: 100%\n}\n.mint-rounded-xl {\n border-radius: 0.75rem\n}","subdomain":"soxai","siteName":"SOXAI API Documentation","title":"Support - SOXAI API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-24T00:53:19.062Z","originalFileLocation":"support.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=\"Request production access or ask a question about the SOXAI API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SOXAI API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/soxai/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/soxai/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/soxai/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/soxai/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Support - SOXAI API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Request production access or ask a question about the SOXAI API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SOXAI API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.soxai.co.jp/support\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://soxai.mintlify.site/_mintlify/api/og/v2?division=About\u0026amp;title=Support\u0026amp;description=Request+production+access+or+ask+a+question+about+the+SOXAI+API.\u0026amp;theme=00612d6b7635ff7c33d4e457\u0026amp;signature=410c5035d5842574215602b9998f14bf22587eed2c5bddf65f914b5a0f3452e4\">\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=\"Support - SOXAI API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Request production access or ask a question about the SOXAI API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://soxai.mintlify.site/_mintlify/api/og/v2?division=About\u0026amp;title=Support\u0026amp;description=Request+production+access+or+ask+a+question+about+the+SOXAI+API.\u0026amp;theme=00612d6b7635ff7c33d4e457\u0026amp;signature=410c5035d5842574215602b9998f14bf22587eed2c5bddf65f914b5a0f3452e4\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/soxai/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SOXAI API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1C8C7A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.soxai.co.jp/support\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/support.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.soxai.co.jp/#organization\",\"name\":\"SOXAI API Documentation\",\"url\":\"https://developers.soxai.co.jp\"},{\"@type\":\"WebSite\",\"@id\":\"https://developers.soxai.co.jp#website\",\"name\":\"SOXAI API Documentation\",\"url\":\"https://developers.soxai.co.jp\",\"publisher\":{\"@id\":\"https://developers.soxai.co.jp/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.soxai.co.jp/support#webpage\",\"url\":\"https://developers.soxai.co.jp/support\",\"name\":\"Support\",\"description\":\"Request production access or ask a question about the SOXAI API.\",\"dateModified\":\"2026-09-24T00:53:19.062Z\",\"isPartOf\":{\"@id\":\"https://developers.soxai.co.jp#website\"},\"breadcrumb\":{\"@id\":\"https://developers.soxai.co.jp/support#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.soxai.co.jp/support#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"About\",\"item\":\"https://developers.soxai.co.jp/glossary\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Support\",\"item\":\"https://developers.soxai.co.jp/support\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://developers.soxai.co.jp/support#article\",\"headline\":\"Support\",\"name\":\"Support\",\"description\":\"Request production access or ask a question about the SOXAI API.\",\"url\":\"https://developers.soxai.co.jp/support\",\"mainEntityOfPage\":{\"@id\":\"https://developers.soxai.co.jp/support#webpage\"},\"dateModified\":\"2026-09-24T00:53:19.062Z\",\"publisher\":{\"@id\":\"https://developers.soxai.co.jp/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.soxai.co.jp#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SOXAI API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"SOXAI API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/support.md","siteName":"SOXAI API Documentation","nav":{"global":null,"groups":[{"group":"Get started","pages":[{"title":"Quickstart","href":"/guides/quickstart"},{"title":"Sandbox","href":"/guides/sandbox"},{"title":"Get a Sandbox API key","href":"/guides/sandbox-api-key"},{"title":"Authentication","href":"/guides/authentication"},{"title":"Rate limits","href":"/guides/rate-limits"},{"title":"Data fields","href":"/guides/data-fields"},{"title":"Troubleshooting","href":"/guides/troubleshooting"}]},{"group":"API Reference (Sandbox)","pages":[{"group":"Authentication","pages":[{"title":"Sign in and obtain an ID token","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json post /api/login","href":"/sandbox-api-reference/authentication/sign-in-and-obtain-an-id-token"},{"title":"Send a password reset email","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json post /api/resetPassword","href":"/sandbox-api-reference/authentication/send-a-password-reset-email"},{"title":"Exchange a refresh token for a new ID token","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json post /api/refreshToken","href":"/sandbox-api-reference/authentication/exchange-a-refresh-token-for-a-new-id-token"},{"title":"Get the caller's own identity and roles","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /app/me","href":"/sandbox-api-reference/authentication/get-the-callers-own-identity-and-roles"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /api/orgs","href":"/sandbox-api-reference/organizations/list-organizations"},{"title":"Create an organization","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json post /api/orgs","href":"/sandbox-api-reference/organizations/create-an-organization"},{"title":"Get one organization","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /api/orgs/{org_id}","href":"/sandbox-api-reference/organizations/get-one-organization"},{"title":"Update an organization","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json put /api/orgs/{org_id}","href":"/sandbox-api-reference/organizations/update-an-organization"},{"title":"Delete an organization","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json delete /api/orgs/{org_id}","href":"/sandbox-api-reference/organizations/delete-an-organization"}]},{"group":"Organization Members","pages":[{"title":"Get the caller's own organization","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/myOrg","href":"/sandbox-api-reference/organization-members/get-the-callers-own-organization"},{"title":"List an organization's members","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/orgs/{org_id}/orgUsers","href":"/sandbox-api-reference/organization-members/list-an-organizations-members"},{"title":"Add a member to an organization","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json post /api/orgs/{org_id}/orgUsers","href":"/sandbox-api-reference/organization-members/add-a-member-to-an-organization"},{"title":"Resend an invitation email","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /api/orgs/{org_id}/ResendInvitationEmail/{uid}","href":"/sandbox-api-reference/organization-members/resend-an-invitation-email"},{"title":"List an organization's members filtered by team","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/orgs/{org_id}/validOrgUsers/teamFilter","href":"/sandbox-api-reference/organization-members/list-an-organizations-members-filtered-by-team"},{"title":"Get one organization member","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/orgs/{org_id}/orgUsers/{uid}","href":"/sandbox-api-reference/organization-members/get-one-organization-member"},{"title":"Update an organization member","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json put /api/orgs/{org_id}/orgUsers/{uid}","href":"/sandbox-api-reference/organization-members/update-an-organization-member"},{"title":"Remove a member from an organization","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json delete /api/orgs/{org_id}/orgUsers/{uid}","href":"/sandbox-api-reference/organization-members/remove-a-member-from-an-organization"},{"title":"Get a member's user profile","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/orgs/{org_id}/orgUsers/{uid}/UserProfile","href":"/sandbox-api-reference/organization-members/get-a-members-user-profile"},{"title":"Update a member's user profile","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json put /api/orgs/{org_id}/orgUsers/{uid}/UserProfile","href":"/sandbox-api-reference/organization-members/update-a-members-user-profile"},{"title":"Rename or delete a team","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json put /api/orgs/{org_id}/teams","href":"/sandbox-api-reference/organization-members/rename-or-delete-a-team"},{"title":"Accept an organization invitation","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json get /api/AcceptEmailVerification/{token}","href":"/sandbox-api-reference/organization-members/accept-an-organization-invitation"}]},{"group":"Data (v1)","pages":[{"title":"Download one user's raw ring records","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/RawData/{query_uid}","href":"/sandbox-api-reference/data-v1/download-one-users-raw-ring-records"},{"title":"Download one user's daily summary data","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/DailyInfoData/{query_uid}","href":"/sandbox-api-reference/data-v1/download-one-users-daily-summary-data"},{"title":"Download one user's intra-day detail data","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/DailyDetailData/{query_uid}","href":"/sandbox-api-reference/data-v1/download-one-users-intra-day-detail-data"}]},{"group":"Data (v2)","pages":[{"title":"Fetch one user's daily summary data (v2)","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/v2/DailyInfoData/{query_uid}","href":"/sandbox-api-reference/data-v2/fetch-one-users-daily-summary-data-v2"},{"title":"Fetch one user's intra-day detail data (v2)","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/v2/DailyDetailData/{query_uid}","href":"/sandbox-api-reference/data-v2/fetch-one-users-intra-day-detail-data-v2"},{"title":"Fetch one user's 7 / 14 / 30-day trend data (v2)","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/v2/DailyTrendData/{query_uid}","href":"/sandbox-api-reference/data-v2/fetch-one-users-7-14-30-day-trend-data-v2"},{"title":"Fetch daily summary data for a whole organization or company (v2)","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/v2/DailyInfoDataForOrg","href":"/sandbox-api-reference/data-v2/fetch-daily-summary-data-for-a-whole-organization-or-company-v2"},{"title":"Fetch intra-day detail data for a whole organization or company (v2)","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/v2/DailyDetailDataForOrg","href":"/sandbox-api-reference/data-v2/fetch-intra-day-detail-data-for-a-whole-organization-or-company-v2"}]},{"group":"Sync Status","pages":[{"title":"Get one user's data-processing log","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /api/ProcessLog/{query_uid}","href":"/sandbox-api-reference/sync-status/get-one-users-data-processing-log"},{"title":"Get the last process log for a user or an organization","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/LastProcessLog","href":"/sandbox-api-reference/sync-status/get-the-last-process-log-for-a-user-or-an-organization"}]},{"group":"System","pages":[{"title":"Liveness check","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json get /api/ping","href":"/sandbox-api-reference/system/liveness-check"},{"title":"Health check","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json get /api/health","href":"/sandbox-api-reference/system/health-check"},{"title":"Health check, per dependency","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json get /api/health_check","href":"/sandbox-api-reference/system/health-check-per-dependency"}]},{"group":"API Keys","pages":[{"title":"Get the caller's API key","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /api-key/secret","href":"/sandbox-api-reference/api-keys/get-the-callers-api-key"},{"title":"Create the caller's API key","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json post /api-key/secret","href":"/sandbox-api-reference/api-keys/create-the-callers-api-key"}]},{"group":"OAuth2","pages":[{"title":"Show the OAuth2 login page","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json get /oauth2/login","href":"/sandbox-api-reference/oauth2/show-the-oauth2-login-page"},{"title":"Check whether the caller agreed to share data with a client","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /oauth2/agreement","href":"/sandbox-api-reference/oauth2/check-whether-the-caller-agreed-to-share-data-with-a-client"},{"title":"Exchange an authorization code for tokens","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json post /oauth2/token","href":"/sandbox-api-reference/oauth2/exchange-an-authorization-code-for-tokens"},{"title":"OpenID Connect discovery document","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json get /.well-known/openid-configuration","href":"/sandbox-api-reference/oauth2/openid-connect-discovery-document"},{"title":"Require or release two-factor for a list of users","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json post /oauth2/users/totp_required","href":"/sandbox-api-reference/oauth2/require-or-release-two-factor-for-a-list-of-users"}]},{"group":"Partner Companies","pages":[{"title":"List a company's users","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /api/companies/users/{company_id}","href":"/sandbox-api-reference/partner-companies/list-a-companys-users"},{"title":"Register a company user with a certificate","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json post /api/companies/users","href":"/sandbox-api-reference/partner-companies/register-a-company-user-with-a-certificate"},{"title":"Change a company user's email with a certificate","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json post /api/companies/users/changeEmail","href":"/sandbox-api-reference/partner-companies/change-a-company-users-email-with-a-certificate"},{"title":"Sign in a company user with a certificate","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json post /api/companies/users/login","href":"/sandbox-api-reference/partner-companies/sign-in-a-company-user-with-a-certificate"},{"title":"Delete all of a company user's data","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json post /api/companies/users/deleteUserData","href":"/sandbox-api-reference/partner-companies/delete-all-of-a-company-users-data"},{"title":"Remove a user from a partner company","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json post /api/companies/users/removeUser","href":"/sandbox-api-reference/partner-companies/remove-a-user-from-a-partner-company"}]},{"group":"Users","pages":[{"title":"Look up a user's ring serial numbers","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json post /api/users/sn","href":"/sandbox-api-reference/users/look-up-a-users-ring-serial-numbers"},{"title":"Get the caller's own ring sync logs","deprecated":null,"version":null,"openapi":"/openapi-sandbox.json get /api/users/sync-logs","href":"/sandbox-api-reference/users/get-the-callers-own-ring-sync-logs"}]},{"group":"Family Groups","pages":[{"title":"List the caller's groups","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /api/groups","href":"/sandbox-api-reference/family-groups/list-the-callers-groups"},{"title":"Create a family group","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json post /api/groups","href":"/sandbox-api-reference/family-groups/create-a-family-group"},{"title":"Get one family group","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /api/groups/{group_id}","href":"/sandbox-api-reference/family-groups/get-one-family-group"},{"title":"Rename a family group","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json put /api/groups/{group_id}","href":"/sandbox-api-reference/family-groups/rename-a-family-group"},{"title":"Dissolve a family group","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json delete /api/groups/{group_id}","href":"/sandbox-api-reference/family-groups/dissolve-a-family-group"},{"title":"Issue a group invite link","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json post /api/groups/{group_id}/invites","href":"/sandbox-api-reference/family-groups/issue-a-group-invite-link"},{"title":"Join a family group with an invite code","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json post /api/groups/join","href":"/sandbox-api-reference/family-groups/join-a-family-group-with-an-invite-code"},{"title":"Get the caller's own membership in a group","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /api/groups/{group_id}/members/me","href":"/sandbox-api-reference/family-groups/get-the-callers-own-membership-in-a-group"},{"title":"Update the caller's own membership settings","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json put /api/groups/{group_id}/members/me","href":"/sandbox-api-reference/family-groups/update-the-callers-own-membership-settings"},{"title":"Leave a family group","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json delete /api/groups/{group_id}/members/me","href":"/sandbox-api-reference/family-groups/leave-a-family-group"},{"title":"Remove several members from a group","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json delete /api/groups/{group_id}/members","href":"/sandbox-api-reference/family-groups/remove-several-members-from-a-group"},{"title":"Remove one member from a group","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json delete /api/groups/{group_id}/members/{uid}","href":"/sandbox-api-reference/family-groups/remove-one-member-from-a-group"},{"title":"Change a member's role in a group","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json put /api/groups/{group_id}/members/{uid}/role","href":"/sandbox-api-reference/family-groups/change-a-members-role-in-a-group"},{"title":"Get every member's reactions in a group","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /api/groups/{group_id}/reactions","href":"/sandbox-api-reference/family-groups/get-every-members-reactions-in-a-group"},{"title":"Send a reaction to a member","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json put /api/groups/{group_id}/reactions/{target_uid}/{emoji_id}","href":"/sandbox-api-reference/family-groups/send-a-reaction-to-a-member"},{"title":"Take back a reaction","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json delete /api/groups/{group_id}/reactions/{target_uid}/{emoji_id}","href":"/sandbox-api-reference/family-groups/take-back-a-reaction"},{"title":"Get a family group's shared health data","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /api/v2/GroupView/{group_id}","href":"/sandbox-api-reference/family-groups/get-a-family-groups-shared-health-data"}]},{"group":"Deep Links","pages":[{"title":"Resolve a group-invite deep link","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /api/deep-link/resolve","href":"/sandbox-api-reference/deep-links/resolve-a-group-invite-deep-link"},{"title":"Generate a prefilled sign-up deep link","deprecated":null,"version":null,"tag":"No Sandbox key","openapi":"/openapi-sandbox.json get /api/deep-link/prefill-link","href":"/sandbox-api-reference/deep-links/generate-a-prefilled-sign-up-deep-link"},{"title":"Exchange a prefill token for its email address","deprecated":null,"version":null,"tag":"Not in Sandbox","openapi":"/openapi-sandbox.json get /api/deep-link/prefill-email","href":"/sandbox-api-reference/deep-links/exchange-a-prefill-token-for-its-email-address"}]}]},{"group":"API Reference (Production)","pages":[{"group":"Authentication","pages":[{"title":"Sign in and obtain an ID token","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api/login","href":"/api-reference/authentication/sign-in-and-obtain-an-id-token"},{"title":"Send a password reset email","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api/resetPassword","href":"/api-reference/authentication/send-a-password-reset-email"},{"title":"Exchange a refresh token for a new ID token","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api/refreshToken","href":"/api-reference/authentication/exchange-a-refresh-token-for-a-new-id-token"},{"title":"Get the caller's own identity and roles","deprecated":null,"version":null,"openapi":"/openapi-public.json get /app/me","href":"/api-reference/authentication/get-the-callers-own-identity-and-roles"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/orgs","href":"/api-reference/organizations/list-organizations"},{"title":"Create an organization","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api/orgs","href":"/api-reference/organizations/create-an-organization"},{"title":"Get one organization","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/orgs/{org_id}","href":"/api-reference/organizations/get-one-organization"},{"title":"Update an organization","deprecated":null,"version":null,"openapi":"/openapi-public.json put /api/orgs/{org_id}","href":"/api-reference/organizations/update-an-organization"},{"title":"Delete an organization","deprecated":null,"version":null,"openapi":"/openapi-public.json delete /api/orgs/{org_id}","href":"/api-reference/organizations/delete-an-organization"}]},{"group":"Organization Members","pages":[{"title":"Get the caller's own organization","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/myOrg","href":"/api-reference/organization-members/get-the-callers-own-organization"},{"title":"List an organization's members","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/orgs/{org_id}/orgUsers","href":"/api-reference/organization-members/list-an-organizations-members"},{"title":"Add a member to an organization","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api/orgs/{org_id}/orgUsers","href":"/api-reference/organization-members/add-a-member-to-an-organization"},{"title":"Resend an invitation email","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/orgs/{org_id}/ResendInvitationEmail/{uid}","href":"/api-reference/organization-members/resend-an-invitation-email"},{"title":"List an organization's members filtered by team","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/orgs/{org_id}/validOrgUsers/teamFilter","href":"/api-reference/organization-members/list-an-organizations-members-filtered-by-team"},{"title":"Get one organization member","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/orgs/{org_id}/orgUsers/{uid}","href":"/api-reference/organization-members/get-one-organization-member"},{"title":"Update an organization member","deprecated":null,"version":null,"openapi":"/openapi-public.json put /api/orgs/{org_id}/orgUsers/{uid}","href":"/api-reference/organization-members/update-an-organization-member"},{"title":"Remove a member from an organization","deprecated":null,"version":null,"openapi":"/openapi-public.json delete /api/orgs/{org_id}/orgUsers/{uid}","href":"/api-reference/organization-members/remove-a-member-from-an-organization"},{"title":"Get a member's user profile","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/orgs/{org_id}/orgUsers/{uid}/UserProfile","href":"/api-reference/organization-members/get-a-members-user-profile"},{"title":"Update a member's user profile","deprecated":null,"version":null,"openapi":"/openapi-public.json put /api/orgs/{org_id}/orgUsers/{uid}/UserProfile","href":"/api-reference/organization-members/update-a-members-user-profile"},{"title":"Rename or delete a team","deprecated":null,"version":null,"openapi":"/openapi-public.json put /api/orgs/{org_id}/teams","href":"/api-reference/organization-members/rename-or-delete-a-team"},{"title":"Accept an organization invitation","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/AcceptEmailVerification/{token}","href":"/api-reference/organization-members/accept-an-organization-invitation"}]},{"group":"Data (v1)","pages":[{"title":"Download one user's raw ring records","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/RawData/{query_uid}","href":"/api-reference/data-v1/download-one-users-raw-ring-records"},{"title":"Download one user's daily summary data","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/DailyInfoData/{query_uid}","href":"/api-reference/data-v1/download-one-users-daily-summary-data"},{"title":"Download one user's intra-day detail data","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/DailyDetailData/{query_uid}","href":"/api-reference/data-v1/download-one-users-intra-day-detail-data"}]},{"group":"Data (v2)","pages":[{"title":"Fetch one user's daily summary data (v2)","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/v2/DailyInfoData/{query_uid}","href":"/api-reference/data-v2/fetch-one-users-daily-summary-data-v2"},{"title":"Fetch one user's intra-day detail data (v2)","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/v2/DailyDetailData/{query_uid}","href":"/api-reference/data-v2/fetch-one-users-intra-day-detail-data-v2"},{"title":"Fetch one user's 7 / 14 / 30-day trend data (v2)","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/v2/DailyTrendData/{query_uid}","href":"/api-reference/data-v2/fetch-one-users-7-14-30-day-trend-data-v2"},{"title":"Fetch daily summary data for a whole organization or company (v2)","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/v2/DailyInfoDataForOrg","href":"/api-reference/data-v2/fetch-daily-summary-data-for-a-whole-organization-or-company-v2"},{"title":"Fetch intra-day detail data for a whole organization or company (v2)","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/v2/DailyDetailDataForOrg","href":"/api-reference/data-v2/fetch-intra-day-detail-data-for-a-whole-organization-or-company-v2"}]},{"group":"Sync Status","pages":[{"title":"Get one user's data-processing log","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/ProcessLog/{query_uid}","href":"/api-reference/sync-status/get-one-users-data-processing-log"},{"title":"Get the last process log for a user or an organization","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/LastProcessLog","href":"/api-reference/sync-status/get-the-last-process-log-for-a-user-or-an-organization"}]},{"group":"System","pages":[{"title":"Liveness check","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/ping","href":"/api-reference/system/liveness-check"},{"title":"Health check","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/health","href":"/api-reference/system/health-check"},{"title":"Health check, per dependency","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/health_check","href":"/api-reference/system/health-check-per-dependency"}]},{"group":"API Keys","pages":[{"title":"Get the caller's API key","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api-key/secret","href":"/api-reference/api-keys/get-the-callers-api-key"},{"title":"Create the caller's API key","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api-key/secret","href":"/api-reference/api-keys/create-the-callers-api-key"}]},{"group":"OAuth2","pages":[{"title":"Show the OAuth2 login page","deprecated":null,"version":null,"openapi":"/openapi-public.json get /oauth2/login","href":"/api-reference/oauth2/show-the-oauth2-login-page"},{"title":"Check whether the caller agreed to share data with a client","deprecated":null,"version":null,"openapi":"/openapi-public.json get /oauth2/agreement","href":"/api-reference/oauth2/check-whether-the-caller-agreed-to-share-data-with-a-client"},{"title":"Exchange an authorization code for tokens","deprecated":null,"version":null,"openapi":"/openapi-public.json post /oauth2/token","href":"/api-reference/oauth2/exchange-an-authorization-code-for-tokens"},{"title":"OpenID Connect discovery document","deprecated":null,"version":null,"openapi":"/openapi-public.json get /.well-known/openid-configuration","href":"/api-reference/oauth2/openid-connect-discovery-document"},{"title":"Require or release two-factor for a list of users","deprecated":null,"version":null,"openapi":"/openapi-public.json post /oauth2/users/totp_required","href":"/api-reference/oauth2/require-or-release-two-factor-for-a-list-of-users"}]},{"group":"Partner Companies","pages":[{"title":"List a company's users","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/companies/users/{company_id}","href":"/api-reference/partner-companies/list-a-companys-users"},{"title":"Register a company user with a certificate","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api/companies/users","href":"/api-reference/partner-companies/register-a-company-user-with-a-certificate"},{"title":"Change a company user's email with a certificate","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api/companies/users/changeEmail","href":"/api-reference/partner-companies/change-a-company-users-email-with-a-certificate"},{"title":"Sign in a company user with a certificate","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api/companies/users/login","href":"/api-reference/partner-companies/sign-in-a-company-user-with-a-certificate"},{"title":"Delete all of a company user's data","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api/companies/users/deleteUserData","href":"/api-reference/partner-companies/delete-all-of-a-company-users-data"},{"title":"Remove a user from a partner company","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api/companies/users/removeUser","href":"/api-reference/partner-companies/remove-a-user-from-a-partner-company"}]},{"group":"Users","pages":[{"title":"Look up a user's ring serial numbers","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api/users/sn","href":"/api-reference/users/look-up-a-users-ring-serial-numbers"},{"title":"Get the caller's own ring sync logs","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/users/sync-logs","href":"/api-reference/users/get-the-callers-own-ring-sync-logs"}]},{"group":"Family Groups","pages":[{"title":"List the caller's groups","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/groups","href":"/api-reference/family-groups/list-the-callers-groups"},{"title":"Create a family group","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api/groups","href":"/api-reference/family-groups/create-a-family-group"},{"title":"Get one family group","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/groups/{group_id}","href":"/api-reference/family-groups/get-one-family-group"},{"title":"Rename a family group","deprecated":null,"version":null,"openapi":"/openapi-public.json put /api/groups/{group_id}","href":"/api-reference/family-groups/rename-a-family-group"},{"title":"Dissolve a family group","deprecated":null,"version":null,"openapi":"/openapi-public.json delete /api/groups/{group_id}","href":"/api-reference/family-groups/dissolve-a-family-group"},{"title":"Issue a group invite link","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api/groups/{group_id}/invites","href":"/api-reference/family-groups/issue-a-group-invite-link"},{"title":"Join a family group with an invite code","deprecated":null,"version":null,"openapi":"/openapi-public.json post /api/groups/join","href":"/api-reference/family-groups/join-a-family-group-with-an-invite-code"},{"title":"Get the caller's own membership in a group","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/groups/{group_id}/members/me","href":"/api-reference/family-groups/get-the-callers-own-membership-in-a-group"},{"title":"Update the caller's own membership settings","deprecated":null,"version":null,"openapi":"/openapi-public.json put /api/groups/{group_id}/members/me","href":"/api-reference/family-groups/update-the-callers-own-membership-settings"},{"title":"Leave a family group","deprecated":null,"version":null,"openapi":"/openapi-public.json delete /api/groups/{group_id}/members/me","href":"/api-reference/family-groups/leave-a-family-group"},{"title":"Remove several members from a group","deprecated":null,"version":null,"openapi":"/openapi-public.json delete /api/groups/{group_id}/members","href":"/api-reference/family-groups/remove-several-members-from-a-group"},{"title":"Remove one member from a group","deprecated":null,"version":null,"openapi":"/openapi-public.json delete /api/groups/{group_id}/members/{uid}","href":"/api-reference/family-groups/remove-one-member-from-a-group"},{"title":"Change a member's role in a group","deprecated":null,"version":null,"openapi":"/openapi-public.json put /api/groups/{group_id}/members/{uid}/role","href":"/api-reference/family-groups/change-a-members-role-in-a-group"},{"title":"Get every member's reactions in a group","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/groups/{group_id}/reactions","href":"/api-reference/family-groups/get-every-members-reactions-in-a-group"},{"title":"Send a reaction to a member","deprecated":null,"version":null,"openapi":"/openapi-public.json put /api/groups/{group_id}/reactions/{target_uid}/{emoji_id}","href":"/api-reference/family-groups/send-a-reaction-to-a-member"},{"title":"Take back a reaction","deprecated":null,"version":null,"openapi":"/openapi-public.json delete /api/groups/{group_id}/reactions/{target_uid}/{emoji_id}","href":"/api-reference/family-groups/take-back-a-reaction"},{"title":"Get a family group's shared health data","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/v2/GroupView/{group_id}","href":"/api-reference/family-groups/get-a-family-groups-shared-health-data"}]},{"group":"Deep Links","pages":[{"title":"Resolve a group-invite deep link","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/deep-link/resolve","href":"/api-reference/deep-links/resolve-a-group-invite-deep-link"},{"title":"Generate a prefilled sign-up deep link","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/deep-link/prefill-link","href":"/api-reference/deep-links/generate-a-prefilled-sign-up-deep-link"},{"title":"Exchange a prefill token for its email address","deprecated":null,"version":null,"openapi":"/openapi-public.json get /api/deep-link/prefill-email","href":"/api-reference/deep-links/exchange-a-prefill-token-for-its-email-address"}]}]},{"group":"About","pages":[{"title":"Glossary","href":"/glossary"},{"title":"Changelog","description":"Changes to the public SOXAI API documentation and OpenAPI specification.","href":"/changelog"},{"title":"Support","href":"/support"}]}]},"basePath":"","title":"Support - SOXAI API Documentation","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["07c022d89b"],"chunks":["Frame-D2acuaLg.js","DynamicMarkdown-Co5nikxh.js"]}