{
"error": "internal-server-error",
"error_msg": "Failed to fetch data: <error_message>"
}
Family Groups
Create a family group
Not callable with a Sandbox key
A request authenticated with a Sandbox soxai-api-key is answered 403 This endpoint is not available in the sandbox., because it changes state that every Sandbox caller shares. It is published here because the Sandbox runs the same build; use it in Production. See Sandbox.
Create a family group with the caller as its first member and admin.
Sharing is opt-in: unless sharedFields says otherwise the creator shares nothing, so no
other member sees their metrics in GroupView until they choose to.
Parameters
Body (GroupCreate): groupName is required. displayName is the caller’s name inside
this group; sharedFields is the initial per-metric sharing selection ({"all": true}
shares every catalog metric).
Response
200 returns the new group document, including the groupId the other group
endpoints take, and the caller’s membership as its first admin.
Errors
Status
Condition
400
groupName is empty
409
The caller already belongs to 20 groups
Authorization
Scheme: Authorization: Bearer <idToken> or soxai-api-key: <api key>.
Any authenticated caller. Group membership is not involved, because this call is what
creates or joins one.
{
"error": "internal-server-error",
"error_msg": "Failed to fetch data: <error_message>"
}
Authorizations
HTTPBearerSoxaiApiKey
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
groupName
string
required
Name of the new group.
Example:
"Family"
displayName
string
Creator's name shown to group members.
Example:
"Jane"
sharedFields
Creator's initial per-metric sharing selection, same shape as the join payload. Omit to keep the opt-in default (nothing shared, so no other member sees the creator's metrics in GroupView). · object
Per-metric sharing choices for the creator.
Show child attributes
Example:
{ "sleep_score": true }
Response
The new group document, including the groupId the other group endpoints take. The caller is already its first admin.
{"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":"sandbox-api-reference/family-groups/create-a-family-group","slug":"/sandbox-api-reference/family-groups/create-a-family-group","pageMetadata":{"title":"Create a family group","description":"\u003cBadge color=\"red\">Not callable with a Sandbox key\u003c/Badge>\n\nA request authenticated with a Sandbox `soxai-api-key` is answered `403 This endpoint is not available in the sandbox.`, because it changes state that every Sandbox caller shares. It is published here because the Sandbox runs the same build; use it in Production. See [Sandbox](/guides/sandbox).\n\nCreate a family group with the caller as its first member and admin.\n\nSharing is opt-in: unless `sharedFields` says otherwise the creator shares nothing, so no\nother member sees their metrics in GroupView until they choose to.\n\n**Parameters**\n\n- Body (`GroupCreate`): `groupName` is required. `displayName` is the caller's name inside\n this group; `sharedFields` is the initial per-metric sharing selection (`{\"all\": true}`\n shares every catalog metric).\n\n**Response**\n\n- `200` returns the new group document, including the `groupId` the other group\n endpoints take, and the caller's membership as its first `admin`.\n\n**Errors**\n\n| Status | Condition |\n| --- | --- |\n| 400 | `groupName` is empty |\n| 409 | The caller already belongs to 20 groups |\n\n**Authorization**\n\n- Scheme: `Authorization: Bearer \u003cidToken>` or `soxai-api-key: \u003capi key>`.\n- Any authenticated caller. Group membership is not involved, because this call is what\n creates or joins one.","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","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n table: \"table\",\n tbody: \"tbody\",\n td: \"td\",\n th: \"th\",\n thead: \"thead\",\n tr: \"tr\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {Badge} = _components;\n if (!Badge) _missingMdxReference(\"Badge\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(Badge, {\n color: \"red\",\n children: \"Not callable with a Sandbox key\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"A request authenticated with a Sandbox \", _jsx(_components.code, {\n children: \"soxai-api-key\"\n }), \" is answered \", _jsx(_components.code, {\n children: \"403 This endpoint is not available in the sandbox.\"\n }), \", because it changes state that every Sandbox caller shares. It is published here because the Sandbox runs the same build; use it in Production. See \", _jsx(_components.a, {\n href: \"/guides/sandbox\",\n children: \"Sandbox\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Create a family group with the caller as its first member and admin.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Sharing is opt-in: unless \", _jsx(_components.code, {\n children: \"sharedFields\"\n }), \" says otherwise the creator shares nothing, so no\\nother member sees their metrics in GroupView until they choose to.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Parameters\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Body (\", _jsx(_components.code, {\n children: \"GroupCreate\"\n }), \"): \", _jsx(_components.code, {\n children: \"groupName\"\n }), \" is required. \", _jsx(_components.code, {\n children: \"displayName\"\n }), \" is the caller’s name inside\\nthis group; \", _jsx(_components.code, {\n children: \"sharedFields\"\n }), \" is the initial per-metric sharing selection (\", _jsx(_components.code, {\n children: \"{\\\"all\\\": true}\"\n }), \"\\nshares every catalog metric).\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Response\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"200\"\n }), \" returns the new group document, including the \", _jsx(_components.code, {\n children: \"groupId\"\n }), \" the other group\\nendpoints take, and the caller’s membership as its first \", _jsx(_components.code, {\n children: \"admin\"\n }), \".\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Errors\"\n })\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"Status\"\n }), _jsx(_components.th, {\n children: \"Condition\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"400\"\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"groupName\"\n }), \" is empty\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"409\"\n }), _jsx(_components.td, {\n children: \"The caller already belongs to 20 groups\"\n })]\n })]\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Authorization\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Scheme: \", _jsx(_components.code, {\n children: \"Authorization: Bearer \u003cidToken>\"\n }), \" or \", _jsx(_components.code, {\n children: \"soxai-api-key: \u003capi key>\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"Any authenticated caller. Group membership is not involved, because this call is what\\ncreates or joins one.\"\n }), \"\\n\"]\n })]\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};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{}},"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":"Create a family group","description":"\u003cBadge color=\"red\">Not callable with a Sandbox key\u003c/Badge>\n\nA request authenticated with a Sandbox `soxai-api-key` is answered `403 This endpoint is not available in the sandbox.`, because it changes state that every Sandbox caller shares. It is published here because the Sandbox runs the same build; use it in Production. See [Sandbox](/guides/sandbox).\n\nCreate a family group with the caller as its first member and admin.\n\nSharing is opt-in: unless `sharedFields` says otherwise the creator shares nothing, so no\nother member sees their metrics in GroupView until they choose to.\n\n**Parameters**\n\n- Body (`GroupCreate`): `groupName` is required. `displayName` is the caller's name inside\n this group; `sharedFields` is the initial per-metric sharing selection (`{\"all\": true}`\n shares every catalog metric).\n\n**Response**\n\n- `200` returns the new group document, including the `groupId` the other group\n endpoints take, and the caller's membership as its first `admin`.\n\n**Errors**\n\n| Status | Condition |\n| --- | --- |\n| 400 | `groupName` is empty |\n| 409 | The caller already belongs to 20 groups |\n\n**Authorization**\n\n- Scheme: `Authorization: Bearer \u003cidToken>` or `soxai-api-key: \u003capi key>`.\n- Any authenticated caller. Group membership is not involved, because this call is what\n creates or joins one.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Family Groups"],"summary":"Create a family group","description":"\u003cBadge color=\"red\">Not callable with a Sandbox key\u003c/Badge>\n\nA request authenticated with a Sandbox `soxai-api-key` is answered `403 This endpoint is not available in the sandbox.`, because it changes state that every Sandbox caller shares. It is published here because the Sandbox runs the same build; use it in Production. See [Sandbox](/guides/sandbox).\n\nCreate a family group with the caller as its first member and admin.\n\nSharing is opt-in: unless `sharedFields` says otherwise the creator shares nothing, so no\nother member sees their metrics in GroupView until they choose to.\n\n**Parameters**\n\n- Body (`GroupCreate`): `groupName` is required. `displayName` is the caller's name inside\n this group; `sharedFields` is the initial per-metric sharing selection (`{\"all\": true}`\n shares every catalog metric).\n\n**Response**\n\n- `200` returns the new group document, including the `groupId` the other group\n endpoints take, and the caller's membership as its first `admin`.\n\n**Errors**\n\n| Status | Condition |\n| --- | --- |\n| 400 | `groupName` is empty |\n| 409 | The caller already belongs to 20 groups |\n\n**Authorization**\n\n- Scheme: `Authorization: Bearer \u003cidToken>` or `soxai-api-key: \u003capi key>`.\n- Any authenticated caller. Group membership is not involved, because this call is what\n creates or joins one.","operationId":"create_family_group","requestBody":"877a136f-a4c0-4097-ba85-574a8260c4c6","responses":{"200":"8b9502a6-96bb-4f42-ba3f-a70960bc306c","400":"469d9cdc-73aa-492e-be40-16b2beaf6346","401":"357e2d97-2fd4-4592-9f72-38f5decc9910","403":"bf404995-5e48-44b7-8d00-1efc886e1b41","409":"37b3fa72-eead-4ca0-a8fb-ab9d8ee79111","422":"c625de40-34ef-480a-824f-6ba69a5e2c04","429":"f0b0f635-9440-4763-9625-de6e40cbca31","500":"92b8a6e7-cd82-41c9-811c-360716a8f620"},"security":["0a697caf-ddf1-4482-8502-05fbff5c2584","1ec627af-fc25-4212-a228-8be30e57f5d4"],"x-mint":{"metadata":{"tag":"No Sandbox key"}},"method":"post","type":"path","servers":["7032f201-5cff-4bfe-84a6-f2850cceb95b"],"path":"/api/groups","baseUrlOptions":["https://web-api.dev.soxai.site"],"title":"Create a family group","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"groupName":{"type":"string","title":"Group Name","description":"Name of the new group.","examples":["Family"],"isRequired":true,"uniqueKey":"groupName","typeLabel":"string"},"displayName":{"type":"string","title":"Creator's display name in this group","description":"Creator's name shown to group members.","examples":["Jane"],"uniqueKey":"displayName","typeLabel":"string"},"sharedFields":{"additionalProperties":{"type":"boolean","uniqueKey":"sharedFields.additionalProperties","typeLabel":"boolean"},"type":"object","title":"Creator's initial per-metric sharing selection, same shape as the join payload. Omit to keep the opt-in default (nothing shared, so no other member sees the creator's metrics in GroupView).","description":"Per-metric sharing choices for the creator.","examples":[{"sleep_score":true}],"uniqueKey":"sharedFields","typeLabel":"Creator's initial per-metric sharing selection, same shape as the join payload. Omit to keep the opt-in default (nothing shared, so no other member sees the creator's metrics in GroupView). · object"}},"type":"object","required":["groupName"],"title":"GroupCreate","uniqueKey":"","typeLabel":"GroupCreate · object"},"examples":{"Example":{"title":"Example","value":{"groupName":"Family","displayName":"Jane","sharedFields":{"sleep_score":true}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"8b9502a6-96bb-4f42-ba3f-a70960bc306c":{"description":"The new group document, including the `groupId` the other group endpoints take. The caller is already its first `admin`.","headers":{"X-RateLimit-Limit":{"description":"Maximum capacity of the continuously refilled minute bucket.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Remaining":{"description":"Whole tokens remaining in the minute bucket after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix timestamp in seconds when the minute bucket is expected to be full. This is not a calendar reset time.","schema":{"type":"integer","minimum":0,"format":"int64"}},"X-RateLimit-Limit-Day":{"description":"Maximum capacity of the continuously refilled daily bucket.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Remaining-Day":{"description":"Whole tokens remaining in the daily bucket after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset-Day":{"description":"Unix timestamp in seconds when the daily bucket is expected to be full. The bucket refills continuously and does not reset at midnight.","schema":{"type":"integer","minimum":0,"format":"int64"}}},"content":{"application/json":{"schema":{},"example":{"groupId":"b7d1f0c9a2e4d6f8b0c1","groupName":"Shibata family","groupType":"family","createdBy":"user123","createdAt":"2026-08-03T09:30:00+00:00","status":"active"},"examples":{"Example":{"title":"Example","value":{"groupId":"b7d1f0c9a2e4d6f8b0c1","groupName":"Shibata family","groupType":"family","createdBy":"user123","createdAt":"2026-08-03T09:30:00+00:00","status":"active"}}},"exampleType":"examples"}},"exampleType":"examples"},"469d9cdc-73aa-492e-be40-16b2beaf6346":{"description":"Bad Request - the request could not be used as given","headers":{"X-RateLimit-Limit":{"description":"Maximum capacity of the continuously refilled minute bucket.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Remaining":{"description":"Whole tokens remaining in the minute bucket after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix timestamp in seconds when the minute bucket is expected to be full. This is not a calendar reset time.","schema":{"type":"integer","minimum":0,"format":"int64"}},"X-RateLimit-Limit-Day":{"description":"Maximum capacity of the continuously refilled daily bucket.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Remaining-Day":{"description":"Whole tokens remaining in the daily bucket after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset-Day":{"description":"Unix timestamp in seconds when the daily bucket is expected to be full. The bucket refills continuously and does not reset at midnight.","schema":{"type":"integer","minimum":0,"format":"int64"}}},"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","title":"Error","description":"Machine-readable error category.","examples":["bad-request"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_msg":{"type":"string","title":"Error Msg","description":"Human-readable explanation of the error; clients must not parse it.","examples":["Invalid input: start_time must use YYYY-MM-DD."],"isRequired":true,"uniqueKey":"error_msg","typeLabel":"string"}},"type":"object","required":["error","error_msg"],"title":"ErrorResponse","description":"The body of every error answer: a machine-readable type and a human-readable message.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"example":{"error":"bad-request","error_msg":"Invalid input: \u003creason>"},"examples":{"Example":{"title":"Example","value":{"error":"bad-request","error_msg":"Invalid input: \u003creason>"}}},"exampleType":"examples"}},"exampleType":"examples"},"357e2d97-2fd4-4592-9f72-38f5decc9910":{"description":"Unauthorized - the credentials are missing, expired or invalid","headers":{"X-RateLimit-Limit":{"description":"Maximum capacity of the continuously refilled minute bucket.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Remaining":{"description":"Whole tokens remaining in the minute bucket after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix timestamp in seconds when the minute bucket is expected to be full. This is not a calendar reset time.","schema":{"type":"integer","minimum":0,"format":"int64"}},"X-RateLimit-Limit-Day":{"description":"Maximum capacity of the continuously refilled daily bucket.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Remaining-Day":{"description":"Whole tokens remaining in the daily bucket after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset-Day":{"description":"Unix timestamp in seconds when the daily bucket is expected to be full. The bucket refills continuously and does not reset at midnight.","schema":{"type":"integer","minimum":0,"format":"int64"}}},"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","title":"Error","description":"Machine-readable error category.","examples":["bad-request"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_msg":{"type":"string","title":"Error Msg","description":"Human-readable explanation of the error; clients must not parse it.","examples":["Invalid input: start_time must use YYYY-MM-DD."],"isRequired":true,"uniqueKey":"error_msg","typeLabel":"string"}},"type":"object","required":["error","error_msg"],"title":"ErrorResponse","description":"The body of every error answer: a machine-readable type and a human-readable message.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"example":{"error":"http-error","error_msg":"Invalid authentication credentials. \u003creason>"},"examples":{"Example":{"title":"Example","value":{"error":"http-error","error_msg":"Invalid authentication credentials. \u003creason>"}}},"exampleType":"examples"}},"exampleType":"examples"},"bf404995-5e48-44b7-8d00-1efc886e1b41":{"description":"Forbidden - Not enough permission","headers":{"X-RateLimit-Limit":{"description":"Maximum capacity of the continuously refilled minute bucket.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Remaining":{"description":"Whole tokens remaining in the minute bucket after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix timestamp in seconds when the minute bucket is expected to be full. This is not a calendar reset time.","schema":{"type":"integer","minimum":0,"format":"int64"}},"X-RateLimit-Limit-Day":{"description":"Maximum capacity of the continuously refilled daily bucket.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Remaining-Day":{"description":"Whole tokens remaining in the daily bucket after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset-Day":{"description":"Unix timestamp in seconds when the daily bucket is expected to be full. The bucket refills continuously and does not reset at midnight.","schema":{"type":"integer","minimum":0,"format":"int64"}}},"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","title":"Error","description":"Machine-readable error category.","examples":["bad-request"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_msg":{"type":"string","title":"Error Msg","description":"Human-readable explanation of the error; clients must not parse it.","examples":["Invalid input: start_time must use YYYY-MM-DD."],"isRequired":true,"uniqueKey":"error_msg","typeLabel":"string"}},"type":"object","required":["error","error_msg"],"title":"ErrorResponse","description":"The body of every error answer: a machine-readable type and a human-readable message.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"example":{"error":"forbidden","error_msg":"Not enough permission"},"examples":{"Example":{"title":"Example","value":{"error":"forbidden","error_msg":"Not enough permission"}}},"exampleType":"examples"}},"exampleType":"examples"},"37b3fa72-eead-4ca0-a8fb-ab9d8ee79111":{"description":"Conflict - the caller already belongs to the maximum number of groups","headers":{"X-RateLimit-Limit":{"description":"Maximum capacity of the continuously refilled minute bucket.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Remaining":{"description":"Whole tokens remaining in the minute bucket after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix timestamp in seconds when the minute bucket is expected to be full. This is not a calendar reset time.","schema":{"type":"integer","minimum":0,"format":"int64"}},"X-RateLimit-Limit-Day":{"description":"Maximum capacity of the continuously refilled daily bucket.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Remaining-Day":{"description":"Whole tokens remaining in the daily bucket after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset-Day":{"description":"Unix timestamp in seconds when the daily bucket is expected to be full. The bucket refills continuously and does not reset at midnight.","schema":{"type":"integer","minimum":0,"format":"int64"}}},"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","title":"Error","description":"Machine-readable error category.","examples":["bad-request"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_msg":{"type":"string","title":"Error Msg","description":"Human-readable explanation of the error; clients must not parse it.","examples":["Invalid input: start_time must use YYYY-MM-DD."],"isRequired":true,"uniqueKey":"error_msg","typeLabel":"string"}},"type":"object","required":["error","error_msg"],"title":"ErrorResponse","description":"The body of every error answer: a machine-readable type and a human-readable message.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"example":{"error":"conflict","error_msg":"a user can belong to at most 20 groups"},"examples":{"Example":{"title":"Example","value":{"error":"conflict","error_msg":"a user can belong to at most 20 groups"}}},"exampleType":"examples"}},"exampleType":"examples"},"c625de40-34ef-480a-824f-6ba69a5e2c04":{"description":"Unprocessable Entity - a request field does not meet the endpoint's validation rules","content":{"application/json":{"schema":{"properties":{"error":{"type":"string","title":"Error","description":"Machine-readable error category.","examples":["bad-request"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_msg":{"type":"string","title":"Error Msg","description":"Human-readable explanation of the error; clients must not parse it.","examples":["Invalid input: start_time must use YYYY-MM-DD."],"isRequired":true,"uniqueKey":"error_msg","typeLabel":"string"}},"type":"object","required":["error","error_msg"],"title":"ErrorResponse","description":"The body of every error answer: a machine-readable type and a human-readable message.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"example":{"error":"unprocessable-entity","error_msg":"body.\u003cfield>: \u003cvalidation message>"},"examples":{"Example":{"title":"Example","value":{"error":"unprocessable-entity","error_msg":"body.\u003cfield>: \u003cvalidation message>"}}},"exampleType":"examples"}},"exampleType":"examples"},"f0b0f635-9440-4763-9625-de6e40cbca31":{"description":"Too Many Requests - the rate limit was exceeded","headers":{"X-RateLimit-Limit":{"description":"Maximum capacity of the continuously refilled minute bucket.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Remaining":{"description":"Whole tokens remaining in the minute bucket after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix timestamp in seconds when the minute bucket is expected to be full. This is not a calendar reset time.","schema":{"type":"integer","minimum":0,"format":"int64"}},"X-RateLimit-Limit-Day":{"description":"Maximum capacity of the continuously refilled daily bucket.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Remaining-Day":{"description":"Whole tokens remaining in the daily bucket after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset-Day":{"description":"Unix timestamp in seconds when the daily bucket is expected to be full. The bucket refills continuously and does not reset at midnight.","schema":{"type":"integer","minimum":0,"format":"int64"}},"Retry-After":{"description":"Whole seconds to wait until both applicable buckets can accept one request. Returned only with a 429 response.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","title":"Error","description":"Machine-readable error category.","examples":["bad-request"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_msg":{"type":"string","title":"Error Msg","description":"Human-readable explanation of the error; clients must not parse it.","examples":["Invalid input: start_time must use YYYY-MM-DD."],"isRequired":true,"uniqueKey":"error_msg","typeLabel":"string"}},"type":"object","required":["error","error_msg"],"title":"ErrorResponse","description":"The body of every error answer: a machine-readable type and a human-readable message.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"example":{"error":"rate-limited","error_msg":"Rate limit exceeded. Retry after \u003cn> seconds."},"examples":{"Example":{"title":"Example","value":{"error":"rate-limited","error_msg":"Rate limit exceeded. Retry after \u003cn> seconds."}}},"exampleType":"examples"}},"exampleType":"examples"},"92b8a6e7-cd82-41c9-811c-360716a8f620":{"description":"Internal Server Error - Failed to fetch data","headers":{"X-RateLimit-Limit":{"description":"Maximum capacity of the continuously refilled minute bucket.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Remaining":{"description":"Whole tokens remaining in the minute bucket after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset":{"description":"Unix timestamp in seconds when the minute bucket is expected to be full. This is not a calendar reset time.","schema":{"type":"integer","minimum":0,"format":"int64"}},"X-RateLimit-Limit-Day":{"description":"Maximum capacity of the continuously refilled daily bucket.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Remaining-Day":{"description":"Whole tokens remaining in the daily bucket after this request.","schema":{"type":"integer","minimum":0}},"X-RateLimit-Reset-Day":{"description":"Unix timestamp in seconds when the daily bucket is expected to be full. The bucket refills continuously and does not reset at midnight.","schema":{"type":"integer","minimum":0,"format":"int64"}}},"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","title":"Error","description":"Machine-readable error category.","examples":["bad-request"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_msg":{"type":"string","title":"Error Msg","description":"Human-readable explanation of the error; clients must not parse it.","examples":["Invalid input: start_time must use YYYY-MM-DD."],"isRequired":true,"uniqueKey":"error_msg","typeLabel":"string"}},"type":"object","required":["error","error_msg"],"title":"ErrorResponse","description":"The body of every error answer: a machine-readable type and a human-readable message.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"example":{"error":"internal-server-error","error_msg":"Failed to fetch data: \u003cerror_message>"},"examples":{"Example":{"title":"Example","value":{"error":"internal-server-error","error_msg":"Failed to fetch data: \u003cerror_message>"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"0a697caf-ddf1-4482-8502-05fbff5c2584":{"HTTPBearer":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"HTTPBearer"}},"1ec627af-fc25-4212-a228-8be30e57f5d4":{"SoxaiApiKey":{"type":"apiKey","description":"API key issued by `POST /api-key/secret`, sent in the `soxai-api-key` header. It is an alternative to the Bearer token, not an addition to it: when both are sent the Bearer token is used. The key carries the same roles as the user it was issued to, and expires after the number of days it was issued for.","in":"header","name":"soxai-api-key","scopes":[],"schemeName":"SoxaiApiKey"}}},"servers":{"7032f201-5cff-4bfe-84a6-f2850cceb95b":{"url":"https://web-api.dev.soxai.site","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"HTTPBearer"},"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":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"},{"schemes":[{"scheme":{"type":"apiKey","description":"API key issued by `POST /api-key/secret`, sent in the `soxai-api-key` header. It is an alternative to the Bearer token, not an addition to it: when both are sent the Bearer token is used. The key carries the same roles as the user it was issued to, and expires after the number of days it was issued for.","in":"header","name":"soxai-api-key","scopes":[],"schemeName":"SoxaiApiKey"},"schema":{"title":"soxai-api-key","type":"string","description":"API key issued by `POST /api-key/secret`, sent in the `soxai-api-key` header. It is an alternative to the Bearer token, not an addition to it: when both are sent the Bearer token is used. The key carries the same roles as the user it was issued to, and expires after the number of days it was issued for.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"SoxaiApiKey","name":"soxai-api-key"}],"title":"SoxaiApiKey"}]},"originalFileLocation":"openapi-sandbox.json"},"subdomain":"soxai","siteName":"SOXAI API Documentation","title":"Create a family group - SOXAI API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T03:26:03.099Z","originalFileLocation":"sandbox-api-reference/family-groups/create-a-family-group.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=\"Not callable with a Sandbox key A request authenticated with a Sandbox soxai-api-key is answered 403 This endpoint is not available in the sandbox., because it changes state that every Sandbox caller shares. It is published here because the Sandbox runs the same build; use it in Production. See Sandbox. Create a family group with the caller as its first member and admin. Sharing is opt-in: unless sharedFields says otherwise the creator shares nothing, so no other member sees their metrics in GroupView until they choose to. Parameters - Body (GroupCreate): groupName is required. displayName is the caller\u0026#x27;s name inside this group; sharedFields is the initial per-metric sharing selection ({\u0026quot;all\u0026quot;: true} shares every catalog metric). Response - 200 returns the new group document, including the groupId the other group endpoints take, and the caller\u0026#x27;s membership as its first admin. Errors | Status | Condition | | --- | --- | | 400 | groupName is empty | | 409 | The caller already belongs to 20 groups | Authorization - Scheme: Authorization: Bearer or soxai-api-key: . - Any authenticated caller. Group membership is not involved, because this call is what creates or joins one.\">\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=\"Create a family group - SOXAI API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Not callable with a Sandbox key A request authenticated with a Sandbox soxai-api-key is answered 403 This endpoint is not available in the sandbox., because it changes state that every Sandbox caller shares. It is published here because the Sandbox runs the same build; use it in Production. See Sandbox. Create a family group with the caller as its first member and admin. Sharing is opt-in: unless sharedFields says otherwise the creator shares nothing, so no other member sees their metrics in GroupView until they choose to. Parameters - Body (GroupCreate): groupName is required. displayName is the caller\u0026#x27;s name inside this group; sharedFields is the initial per-metric sharing selection ({\u0026quot;all\u0026quot;: true} shares every catalog metric). Response - 200 returns the new group document, including the groupId the other group endpoints take, and the caller\u0026#x27;s membership as its first admin. Errors | Status | Condition | | --- | --- | | 400 | groupName is empty | | 409 | The caller already belongs to 20 groups | Authorization - Scheme: Authorization: Bearer or soxai-api-key: . - Any authenticated caller. Group membership is not involved, because this call is what creates or joins one.\">\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/sandbox-api-reference/family-groups/create-a-family-group\">\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=Family+Groups\u0026amp;title=Create+a+family+group\u0026amp;description=%3CBadge+color%3D%22red%22%3ENot+callable+with+a+Sandbox+key%3C%2FBadge%3E%0A%0AA+request+authenticated+with+a+Sandbox+%60soxai-api-key%60+is+answered+%60403+This+endpoint+is+not+availab\u0026amp;theme=00612d6b7635ff7c33d4e457\u0026amp;signature=716627d6edaaca44e3929052a19cdf6d2df1f50d5560eb2e6397c01d99f81c3b\">\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=\"Create a family group - SOXAI API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Not callable with a Sandbox key A request authenticated with a Sandbox soxai-api-key is answered 403 This endpoint is not available in the sandbox., because it changes state that every Sandbox caller shares. It is published here because the Sandbox runs the same build; use it in Production. See Sandbox. Create a family group with the caller as its first member and admin. Sharing is opt-in: unless sharedFields says otherwise the creator shares nothing, so no other member sees their metrics in GroupView until they choose to. Parameters - Body (GroupCreate): groupName is required. displayName is the caller\u0026#x27;s name inside this group; sharedFields is the initial per-metric sharing selection ({\u0026quot;all\u0026quot;: true} shares every catalog metric). Response - 200 returns the new group document, including the groupId the other group endpoints take, and the caller\u0026#x27;s membership as its first admin. Errors | Status | Condition | | --- | --- | | 400 | groupName is empty | | 409 | The caller already belongs to 20 groups | Authorization - Scheme: Authorization: Bearer or soxai-api-key: . - Any authenticated caller. Group membership is not involved, because this call is what creates or joins one.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://soxai.mintlify.site/_mintlify/api/og/v2?division=Family+Groups\u0026amp;title=Create+a+family+group\u0026amp;description=%3CBadge+color%3D%22red%22%3ENot+callable+with+a+Sandbox+key%3C%2FBadge%3E%0A%0AA+request+authenticated+with+a+Sandbox+%60soxai-api-key%60+is+answered+%60403+This+endpoint+is+not+availab\u0026amp;theme=00612d6b7635ff7c33d4e457\u0026amp;signature=716627d6edaaca44e3929052a19cdf6d2df1f50d5560eb2e6397c01d99f81c3b\">\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/sandbox-api-reference/family-groups/create-a-family-group\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/sandbox-api-reference/family-groups/create-a-family-group.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/sandbox-api-reference/family-groups/create-a-family-group#webpage\",\"url\":\"https://developers.soxai.co.jp/sandbox-api-reference/family-groups/create-a-family-group\",\"name\":\"Create a family group\",\"description\":\"Not callable with a Sandbox key A request authenticated with a Sandbox soxai-api-key is answered 403 This endpoint is not available in the sandbox., because it changes state that every Sandbox caller shares. It is published here because the Sandbox runs the same build; use it in Production. See Sandbox. Create a family group with the caller as its first member and admin. Sharing is opt-in: unless sharedFields says otherwise the creator shares nothing, so no other member sees their metrics in GroupView until they choose to. Parameters - Body (GroupCreate): groupName is required. displayName is the caller's name inside this group; sharedFields is the initial per-metric sharing selection ({\\\"all\\\": true} shares every catalog metric). Response - 200 returns the new group document, including the groupId the other group endpoints take, and the caller's membership as its first admin. Errors | Status | Condition | | --- | --- | | 400 | groupName is empty | | 409 | The caller already belongs to 20 groups | Authorization - Scheme: Authorization: Bearer or soxai-api-key: . - Any authenticated caller. Group membership is not involved, because this call is what creates or joins one.\",\"dateModified\":\"2026-11-13T03:26:03.099Z\",\"isPartOf\":{\"@id\":\"https://developers.soxai.co.jp#website\"},\"breadcrumb\":{\"@id\":\"https://developers.soxai.co.jp/sandbox-api-reference/family-groups/create-a-family-group#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.soxai.co.jp/sandbox-api-reference/family-groups/create-a-family-group#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference (Sandbox)\",\"item\":\"https://developers.soxai.co.jp/sandbox-api-reference/authentication/sign-in-and-obtain-an-id-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Family Groups\",\"item\":\"https://developers.soxai.co.jp/sandbox-api-reference/family-groups/list-the-callers-groups\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a family group\",\"item\":\"https://developers.soxai.co.jp/sandbox-api-reference/family-groups/create-a-family-group\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.soxai.co.jp/sandbox-api-reference/family-groups/create-a-family-group#apireference\",\"headline\":\"Create a family group\",\"name\":\"Create a family group\",\"description\":\"Not callable with a Sandbox key A request authenticated with a Sandbox soxai-api-key is answered 403 This endpoint is not available in the sandbox., because it changes state that every Sandbox caller shares. It is published here because the Sandbox runs the same build; use it in Production. See Sandbox. Create a family group with the caller as its first member and admin. Sharing is opt-in: unless sharedFields says otherwise the creator shares nothing, so no other member sees their metrics in GroupView until they choose to. Parameters - Body (GroupCreate): groupName is required. displayName is the caller's name inside this group; sharedFields is the initial per-metric sharing selection ({\\\"all\\\": true} shares every catalog metric). Response - 200 returns the new group document, including the groupId the other group endpoints take, and the caller's membership as its first admin. Errors | Status | Condition | | --- | --- | | 400 | groupName is empty | | 409 | The caller already belongs to 20 groups | Authorization - Scheme: Authorization: Bearer or soxai-api-key: . - Any authenticated caller. Group membership is not involved, because this call is what creates or joins one.\",\"url\":\"https://developers.soxai.co.jp/sandbox-api-reference/family-groups/create-a-family-group\",\"mainEntityOfPage\":{\"@id\":\"https://developers.soxai.co.jp/sandbox-api-reference/family-groups/create-a-family-group#webpage\"},\"dateModified\":\"2026-11-13T03:26:03.099Z\",\"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":"/sandbox-api-reference/family-groups/create-a-family-group.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","description":"\u003cBadge color=\"red\">Not callable with a Sandbox key\u003c/Badge>\n\nA request authenticated with a Sandbox `soxai-api-key` is answered `403 This endpoint is not available in the sandbox.`, because it is internal or operational, outside the Sandbox surface. It is published here because the Sandbox runs the same build; use it in Production. See [Sandbox](/guides/sandbox).\n\nEvery group the caller belongs to, with its creation time, roster size and\n**the caller's own sharing settings in that group** (SOX-67).\n\nSharing is per membership, so the group-list screen shows a different set of\nmetric chips per card: `sharedFieldNames` is that set — the resolved list of\nwhat the caller shares there, already accounting for `sharedFields.all` and\n`masterHidden` (`[]` when hidden). `sharedFields` / `masterHidden` are the raw\ntoggles behind it, for the edit screen.\n\nEach row also carries what the rest of the card needs, so drawing the list\ncosts one call instead of one GroupView per group (SOX-82):\n\n- `members` — the roster behind the avatar row: `uid` / `displayName` / `role`\n / `joinedAt` / `isSelf` / `visibleFields`, caller first then oldest\n membership first. `joinedAt` (SOX-92) is when that membership started, as\n offset-carrying ISO 8601 like the group's `createdAt` — the key the order\n after the caller is derived from, and null only for a member seeded\n without one.\n **Identity and masks only.** Health values stay in GroupView, which is still\n the single data-view endpoint (spec §3.5); open a group to get them.\n- `watching` — the \"watching over\" badge (見守り中): true when at least one\n *other* member shares at least one metric with the caller. False for a solo\n group and for one where everyone has set `masterHidden`, whatever\n `memberCount` says.\n\n**Parameters**\n\n- None. This endpoint takes no path, query or body parameter.\n\n**Response**\n\n- `200` `{\"groups\": [...]}`, one entry per group the caller is an active member of.\n A caller in no group receives an empty list, not a `404`.\n- A membership pointing at a group that has since been dissolved is skipped rather\n than reported.\n\n**Errors**\n\n- None. Every answer is built from the caller's own memberships, so there is nothing\n to be refused or not found.\n\n**Authorization**\n\n- Scheme: `Authorization: Bearer \u003cidToken>` or `soxai-api-key: \u003capi key>`.\n- Any authenticated caller. The list is built from the caller's own membership records,\n so no group role is involved and no group the caller does not belong to appears.","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","description":"\u003cBadge color=\"red\">Not callable with a Sandbox key\u003c/Badge>\n\nA request authenticated with a Sandbox `soxai-api-key` is answered `403 This endpoint is not available in the sandbox.`, because it is internal or operational, outside the Sandbox surface. It is published here because the Sandbox runs the same build; use it in Production. See [Sandbox](/guides/sandbox).\n\nOne group by id — the same keys as a `GET /api/groups` entry plus groupType\nand createdBy. Member *identity* comes with the entry (`members`, SOX-82);\nmember *health data* lives in GroupView.\n\n**Parameters**\n\n- `group_id` (path, required) - the group to describe.\n\n**Response**\n\n- `200` returns the same keys as a `GET /api/groups` entry, plus `groupType`,\n `createdBy` and `members`, the roster's identities.\n\n**Errors**\n\n| Status | Condition |\n| --- | --- |\n| 404 | The group does not exist. Only an active member of some other group reaches this: a non-member is refused with `403` first |\n\n**Authorization**\n\n- Scheme: `Authorization: Bearer \u003cidToken>` or `soxai-api-key: \u003capi key>`.\n- Authority inside a group comes from the caller's own membership record, never from a SOXAI\n role: an `Admin`, `PartnerAdmin` or `OrgAdmin` claim grants nothing here.\n- Required: an active member of the group. A caller who is not one receives\n `403 not a member of this group`, whether or not the group exists.","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","href":"/changelog"},{"title":"Support","href":"/support"}]}]},"basePath":"","title":"Create a family group - SOXAI API Documentation","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}