# SOXAI API Documentation

- [Quickstart](https://developers.soxai.co.jp/guides/quickstart.md): Sign in and retrieve SOXAI daily data.
- [Sandbox](https://developers.soxai.co.jp/guides/sandbox.md): Create a Sandbox credential and test the SOXAI API with fixed sample data.
- [Get a Sandbox API key](https://developers.soxai.co.jp/guides/sandbox-api-key.md): Register an email address and receive an API key for the SOXAI API Sandbox.
- [Authentication](https://developers.soxai.co.jp/guides/authentication.md): Choose and use a SOXAI API credential.
- [Rate limits](https://developers.soxai.co.jp/guides/rate-limits.md): Understand the SOXAI API request limits and build clients that handle them.
- [Data fields](https://developers.soxai.co.jp/guides/data-fields.md): Understand field names, missing values, and units in SOXAI data responses.
- [Troubleshooting](https://developers.soxai.co.jp/guides/troubleshooting.md): Find common causes of missing data, invitations, and validation errors.
- [Sign in and obtain an ID token](https://developers.soxai.co.jp/sandbox-api-reference/authentication/sign-in-and-obtain-an-id-token.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Send a password reset email](https://developers.soxai.co.jp/sandbox-api-reference/authentication/send-a-password-reset-email.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Exchange a refresh token for a new ID token](https://developers.soxai.co.jp/sandbox-api-reference/authentication/exchange-a-refresh-token-for-a-new-id-token.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Get the caller's own identity and roles](https://developers.soxai.co.jp/sandbox-api-reference/authentication/get-the-callers-own-identity-and-roles.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [List organizations](https://developers.soxai.co.jp/sandbox-api-reference/organizations/list-organizations.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Create an organization](https://developers.soxai.co.jp/sandbox-api-reference/organizations/create-an-organization.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Get one organization](https://developers.soxai.co.jp/sandbox-api-reference/organizations/get-one-organization.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Update an organization](https://developers.soxai.co.jp/sandbox-api-reference/organizations/update-an-organization.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Delete an organization](https://developers.soxai.co.jp/sandbox-api-reference/organizations/delete-an-organization.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Get the caller's own organization](https://developers.soxai.co.jp/sandbox-api-reference/organization-members/get-the-callers-own-organization.md): Report which organization the caller belongs to, if any.
- [List an organization's members](https://developers.soxai.co.jp/sandbox-api-reference/organization-members/list-an-organizations-members.md): List every member on an organization's roster.
- [Add a member to an organization](https://developers.soxai.co.jp/sandbox-api-reference/organization-members/add-a-member-to-an-organization.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Resend an invitation email](https://developers.soxai.co.jp/sandbox-api-reference/organization-members/resend-an-invitation-email.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [List an organization's members filtered by team](https://developers.soxai.co.jp/sandbox-api-reference/organization-members/list-an-organizations-members-filtered-by-team.md): List the members of an organization that belong to any of the given teams, as both a uid list and the full roster documents.
- [Get one organization member](https://developers.soxai.co.jp/sandbox-api-reference/organization-members/get-one-organization-member.md): Fetch a single member's roster entry: their email, username, teams, admin flag and invitation status within this organization.
- [Update an organization member](https://developers.soxai.co.jp/sandbox-api-reference/organization-members/update-an-organization-member.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Remove a member from an organization](https://developers.soxai.co.jp/sandbox-api-reference/organization-members/remove-a-member-from-an-organization.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Get a member's user profile](https://developers.soxai.co.jp/sandbox-api-reference/organization-members/get-a-members-user-profile.md): Fetch a member's personal profile (`{uid}/user_profile`): their device and account attributes, as opposed to their roster entry in this organization.
- [Update a member's user profile](https://developers.soxai.co.jp/sandbox-api-reference/organization-members/update-a-members-user-profile.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Rename or delete a team](https://developers.soxai.co.jp/sandbox-api-reference/organization-members/rename-or-delete-a-team.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Accept an organization invitation](https://developers.soxai.co.jp/sandbox-api-reference/organization-members/accept-an-organization-invitation.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Download one user's raw ring records](https://developers.soxai.co.jp/sandbox-api-reference/data-v1/download-one-users-raw-ring-records.md): Download the raw records the ring uploaded for one user, as CSV or JSON.
- [Download one user's daily summary data](https://developers.soxai.co.jp/sandbox-api-reference/data-v1/download-one-users-daily-summary-data.md): Download day-level summary records (`SX_Daily_Prod`) for one user, as CSV or JSON.
- [Download one user's intra-day detail data](https://developers.soxai.co.jp/sandbox-api-reference/data-v1/download-one-users-intra-day-detail-data.md): Download intra-day detail records (`SX_Detail_Prod`) for one user, as CSV or JSON.
- [Fetch one user's daily summary data (v2)](https://developers.soxai.co.jp/sandbox-api-reference/data-v2/fetch-one-users-daily-summary-data-v2.md): Fetch daily info data (SX_Daily_Prod) with standardized field names.
- [Fetch one user's intra-day detail data (v2)](https://developers.soxai.co.jp/sandbox-api-reference/data-v2/fetch-one-users-intra-day-detail-data-v2.md): Fetch daily detail data (SX_Detail_Prod) with standardized field names.
- [Fetch one user's 7 / 14 / 30-day trend data (v2)](https://developers.soxai.co.jp/sandbox-api-reference/data-v2/fetch-one-users-7-14-30-day-trend-data-v2.md): Fetch trend/summary data (SX_Sum7_Prod, SX_Sum14_Prod, SX_Sum30_Prod).
- [Fetch daily summary data for a whole organization or company (v2)](https://developers.soxai.co.jp/sandbox-api-reference/data-v2/fetch-daily-summary-data-for-a-whole-organization-or-company-v2.md): Fetch daily summary records (`SX_Daily_Prod`) with standardized field names for every reachable member of an organization or a company.
- [Fetch intra-day detail data for a whole organization or company (v2)](https://developers.soxai.co.jp/sandbox-api-reference/data-v2/fetch-intra-day-detail-data-for-a-whole-organization-or-company-v2.md): Fetch intra-day detail records (`SX_Detail_Prod`) with standardized field names for every reachable member of an organization or a company.
- [Get one user's data-processing log](https://developers.soxai.co.jp/sandbox-api-reference/sync-status/get-one-users-data-processing-log.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Get the last process log for a user or an organization](https://developers.soxai.co.jp/sandbox-api-reference/sync-status/get-the-last-process-log-for-a-user-or-an-organization.md): Report the most recent processing record for one user, or for every member of an organization.
- [Liveness check](https://developers.soxai.co.jp/sandbox-api-reference/system/liveness-check.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Health check](https://developers.soxai.co.jp/sandbox-api-reference/system/health-check.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Health check, per dependency](https://developers.soxai.co.jp/sandbox-api-reference/system/health-check-per-dependency.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Get the caller's API key](https://developers.soxai.co.jp/sandbox-api-reference/api-keys/get-the-callers-api-key.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Create the caller's API key](https://developers.soxai.co.jp/sandbox-api-reference/api-keys/create-the-callers-api-key.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Show the OAuth2 login page](https://developers.soxai.co.jp/sandbox-api-reference/oauth2/show-the-oauth2-login-page.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Check whether the caller agreed to share data with a client](https://developers.soxai.co.jp/sandbox-api-reference/oauth2/check-whether-the-caller-agreed-to-share-data-with-a-client.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Exchange an authorization code for tokens](https://developers.soxai.co.jp/sandbox-api-reference/oauth2/exchange-an-authorization-code-for-tokens.md): <Badge color="red">Not part of the Sandbox</Badge>
- [OpenID Connect discovery document](https://developers.soxai.co.jp/sandbox-api-reference/oauth2/openid-connect-discovery-document.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Require or release two-factor for a list of users](https://developers.soxai.co.jp/sandbox-api-reference/oauth2/require-or-release-two-factor-for-a-list-of-users.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [List a company's users](https://developers.soxai.co.jp/sandbox-api-reference/partner-companies/list-a-companys-users.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Register a company user with a certificate](https://developers.soxai.co.jp/sandbox-api-reference/partner-companies/register-a-company-user-with-a-certificate.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Change a company user's email with a certificate](https://developers.soxai.co.jp/sandbox-api-reference/partner-companies/change-a-company-users-email-with-a-certificate.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Sign in a company user with a certificate](https://developers.soxai.co.jp/sandbox-api-reference/partner-companies/sign-in-a-company-user-with-a-certificate.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Delete all of a company user's data](https://developers.soxai.co.jp/sandbox-api-reference/partner-companies/delete-all-of-a-company-users-data.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Remove a user from a partner company](https://developers.soxai.co.jp/sandbox-api-reference/partner-companies/remove-a-user-from-a-partner-company.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Look up a user's ring serial numbers](https://developers.soxai.co.jp/sandbox-api-reference/users/look-up-a-users-ring-serial-numbers.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Get the caller's own ring sync logs](https://developers.soxai.co.jp/sandbox-api-reference/users/get-the-callers-own-ring-sync-logs.md): Read the caller's own ring synchronisation history: when their ring last uploaded data, and how much.
- [List the caller's groups](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/list-the-callers-groups.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Create a family group](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/create-a-family-group.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Get one family group](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/get-one-family-group.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Rename a family group](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/rename-a-family-group.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Dissolve a family group](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/dissolve-a-family-group.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Issue a group invite link](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/issue-a-group-invite-link.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Join a family group with an invite code](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/join-a-family-group-with-an-invite-code.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Get the caller's own membership in a group](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/get-the-callers-own-membership-in-a-group.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Update the caller's own membership settings](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/update-the-callers-own-membership-settings.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Leave a family group](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/leave-a-family-group.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Remove several members from a group](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/remove-several-members-from-a-group.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Remove one member from a group](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/remove-one-member-from-a-group.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Change a member's role in a group](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/change-a-members-role-in-a-group.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Get every member's reactions in a group](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/get-every-members-reactions-in-a-group.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Send a reaction to a member](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/send-a-reaction-to-a-member.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Take back a reaction](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/take-back-a-reaction.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Get a family group's shared health data](https://developers.soxai.co.jp/sandbox-api-reference/family-groups/get-a-family-groups-shared-health-data.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Resolve a group-invite deep link](https://developers.soxai.co.jp/sandbox-api-reference/deep-links/resolve-a-group-invite-deep-link.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Generate a prefilled sign-up deep link](https://developers.soxai.co.jp/sandbox-api-reference/deep-links/generate-a-prefilled-sign-up-deep-link.md): <Badge color="red">Not callable with a Sandbox key</Badge>
- [Exchange a prefill token for its email address](https://developers.soxai.co.jp/sandbox-api-reference/deep-links/exchange-a-prefill-token-for-its-email-address.md): <Badge color="red">Not part of the Sandbox</Badge>
- [Sign in and obtain an ID token](https://developers.soxai.co.jp/api-reference/authentication/sign-in-and-obtain-an-id-token.md): Sign in with a SOXAI app account and receive the tokens every other endpoint takes.
- [Send a password reset email](https://developers.soxai.co.jp/api-reference/authentication/send-a-password-reset-email.md): Ask SOXAI Authentication to send a password reset email, in Japanese, to the given address.
- [Exchange a refresh token for a new ID token](https://developers.soxai.co.jp/api-reference/authentication/exchange-a-refresh-token-for-a-new-id-token.md): Exchange the `refreshToken` from `POST /api/login` for a fresh `idToken`, without asking for the password again.
- [Get the caller's own identity and roles](https://developers.soxai.co.jp/api-reference/authentication/get-the-callers-own-identity-and-roles.md): Report who the caller is, as the API sees them: their uid, the roles their token carries, and the organization their token names.
- [List organizations](https://developers.soxai.co.jp/api-reference/organizations/list-organizations.md): List the organizations the caller can see, each with its current member count.
- [Create an organization](https://developers.soxai.co.jp/api-reference/organizations/create-an-organization.md): Create an organization. An organization owns a member roster (`OrgUsers`) and is the unit every org-scoped endpoint addresses by the `org_id` this call returns.
- [Get one organization](https://developers.soxai.co.jp/api-reference/organizations/get-one-organization.md): Fetch a single organization document.
- [Update an organization](https://developers.soxai.co.jp/api-reference/organizations/update-an-organization.md): Update an organization. **Only the fields the request actually carries are written**, so naming `orgName` alone renames the organization and leaves everything else, `companyId` included, untouched.
- [Delete an organization](https://developers.soxai.co.jp/api-reference/organizations/delete-an-organization.md): Delete an organization together with its member roster.
- [Get the caller's own organization](https://developers.soxai.co.jp/api-reference/organization-members/get-the-callers-own-organization.md): Report which organization the caller belongs to, if any.
- [List an organization's members](https://developers.soxai.co.jp/api-reference/organization-members/list-an-organizations-members.md): List every member on an organization's roster.
- [Add a member to an organization](https://developers.soxai.co.jp/api-reference/organization-members/add-a-member-to-an-organization.md): Enrol an existing SOXAI account on an organization's roster by email.
- [Resend an invitation email](https://developers.soxai.co.jp/api-reference/organization-members/resend-an-invitation-email.md): Send the invitation email again to a member who has not accepted yet.
- [List an organization's members filtered by team](https://developers.soxai.co.jp/api-reference/organization-members/list-an-organizations-members-filtered-by-team.md): List the members of an organization that belong to any of the given teams, as both a uid list and the full roster documents.
- [Get one organization member](https://developers.soxai.co.jp/api-reference/organization-members/get-one-organization-member.md): Fetch a single member's roster entry: their email, username, teams, admin flag and invitation status within this organization.
- [Update an organization member](https://developers.soxai.co.jp/api-reference/organization-members/update-an-organization-member.md): Update a member's roster entry: their username, teams, organization admin flag, and data-sharing status.
- [Remove a member from an organization](https://developers.soxai.co.jp/api-reference/organization-members/remove-a-member-from-an-organization.md): Remove a member from an organization's roster and clear the `orgId` claim that gave them org-scoped access.
- [Get a member's user profile](https://developers.soxai.co.jp/api-reference/organization-members/get-a-members-user-profile.md): Fetch a member's personal profile (`{uid}/user_profile`): their device and account attributes, as opposed to their roster entry in this organization.
- [Update a member's user profile](https://developers.soxai.co.jp/api-reference/organization-members/update-a-members-user-profile.md): Update fields of a member's personal profile (`{uid}/user_profile`).
- [Rename or delete a team](https://developers.soxai.co.jp/api-reference/organization-members/rename-or-delete-a-team.md): Rename a team across every member of an organization that carries it.
- [Accept an organization invitation](https://developers.soxai.co.jp/api-reference/organization-members/accept-an-organization-invitation.md): Accept an organization invitation from the link in the invitation email. The invited member's status changes from `Invitation Pending` to `Activated`, which is what makes their data visible to that organization's admins.
- [Download one user's raw ring records](https://developers.soxai.co.jp/api-reference/data-v1/download-one-users-raw-ring-records.md): Download the raw records the ring uploaded for one user, as CSV or JSON.
- [Download one user's daily summary data](https://developers.soxai.co.jp/api-reference/data-v1/download-one-users-daily-summary-data.md): Download day-level summary records (`SX_Daily_Prod`) for one user, as CSV or JSON.
- [Download one user's intra-day detail data](https://developers.soxai.co.jp/api-reference/data-v1/download-one-users-intra-day-detail-data.md): Download intra-day detail records (`SX_Detail_Prod`) for one user, as CSV or JSON.
- [Fetch one user's daily summary data (v2)](https://developers.soxai.co.jp/api-reference/data-v2/fetch-one-users-daily-summary-data-v2.md): Fetch daily info data (SX_Daily_Prod) with standardized field names.
- [Fetch one user's intra-day detail data (v2)](https://developers.soxai.co.jp/api-reference/data-v2/fetch-one-users-intra-day-detail-data-v2.md): Fetch daily detail data (SX_Detail_Prod) with standardized field names.
- [Fetch one user's 7 / 14 / 30-day trend data (v2)](https://developers.soxai.co.jp/api-reference/data-v2/fetch-one-users-7-14-30-day-trend-data-v2.md): Fetch trend/summary data (SX_Sum7_Prod, SX_Sum14_Prod, SX_Sum30_Prod).
- [Fetch daily summary data for a whole organization or company (v2)](https://developers.soxai.co.jp/api-reference/data-v2/fetch-daily-summary-data-for-a-whole-organization-or-company-v2.md): Fetch daily summary records (`SX_Daily_Prod`) with standardized field names for every reachable member of an organization or a company.
- [Fetch intra-day detail data for a whole organization or company (v2)](https://developers.soxai.co.jp/api-reference/data-v2/fetch-intra-day-detail-data-for-a-whole-organization-or-company-v2.md): Fetch intra-day detail records (`SX_Detail_Prod`) with standardized field names for every reachable member of an organization or a company.
- [Get one user's data-processing log](https://developers.soxai.co.jp/api-reference/sync-status/get-one-users-data-processing-log.md): Read the processing log SOXAI keeps for one user: which days have been processed and when.
- [Get the last process log for a user or an organization](https://developers.soxai.co.jp/api-reference/sync-status/get-the-last-process-log-for-a-user-or-an-organization.md): Report the most recent processing record for one user, or for every member of an organization.
- [Liveness check](https://developers.soxai.co.jp/api-reference/system/liveness-check.md): Confirm that the API process is running.
- [Health check](https://developers.soxai.co.jp/api-reference/system/health-check.md): Report whether the API and the services it depends on are reachable.
- [Health check, per dependency](https://developers.soxai.co.jp/api-reference/system/health-check-per-dependency.md): Report the health of each dependency separately: Firestore, and both InfluxDB clients (`query_db` and `raw_db`).
- [Get the caller's API key](https://developers.soxai.co.jp/api-reference/api-keys/get-the-callers-api-key.md): Read back the API key issued to the caller's own account.
- [Create the caller's API key](https://developers.soxai.co.jp/api-reference/api-keys/create-the-callers-api-key.md): Issue an API key for the caller's own account.
- [Show the OAuth2 login page](https://developers.soxai.co.jp/api-reference/oauth2/show-the-oauth2-login-page.md): Render the SOXAI login page that starts the OAuth2 authorization code flow. A third-party client sends the user's browser here.
- [Check whether the caller agreed to share data with a client](https://developers.soxai.co.jp/api-reference/oauth2/check-whether-the-caller-agreed-to-share-data-with-a-client.md): Report whether the caller has agreed to share their SOXAI data with a given OAuth2 client, and when they last changed that answer.
- [Exchange an authorization code for tokens](https://developers.soxai.co.jp/api-reference/oauth2/exchange-an-authorization-code-for-tokens.md): Exchange the authorization `code` from the consent redirect for the end user's tokens. This is the OAuth2 token endpoint, called by the client's backend rather than by a browser.
- [OpenID Connect discovery document](https://developers.soxai.co.jp/api-reference/oauth2/openid-connect-discovery-document.md): The OpenID Connect discovery document: the issuer, the JWKS URI, and the authorization and token endpoint URLs an OIDC client needs in order to configure itself.
- [Require or release two-factor for a list of users](https://developers.soxai.co.jp/api-reference/oauth2/require-or-release-two-factor-for-a-list-of-users.md): [Admin / PartnerAdmin / OrgAdmin] Bulk enable or disable 2FA requirement for a list of users.
- [List a company's users](https://developers.soxai.co.jp/api-reference/partner-companies/list-a-companys-users.md): List the users registered under a partner company, as JSON or as a CSV download.
- [Register a company user with a certificate](https://developers.soxai.co.jp/api-reference/partner-companies/register-a-company-user-with-a-certificate.md): Register a new SOXAI user on behalf of a partner company, identified by the company's own external user id.
- [Change a company user's email with a certificate](https://developers.soxai.co.jp/api-reference/partner-companies/change-a-company-users-email-with-a-certificate.md): Change the email address of a user the partner company registered.
- [Sign in a company user with a certificate](https://developers.soxai.co.jp/api-reference/partner-companies/sign-in-a-company-user-with-a-certificate.md): Sign in a user the partner company registered, and return tokens for the SOXAI API.
- [Delete all of a company user's data](https://developers.soxai.co.jp/api-reference/partner-companies/delete-all-of-a-company-users-data.md): Delete every record SOXAI holds for one of the partner company's users.
- [Remove a user from a partner company](https://developers.soxai.co.jp/api-reference/partner-companies/remove-a-user-from-a-partner-company.md): Take a user off a partner company's roster.
- [Look up a user's ring serial numbers](https://developers.soxai.co.jp/api-reference/users/look-up-a-users-ring-serial-numbers.md): Look up the ring serial number(s) for a user identified by uid or email.
- [Get the caller's own ring sync logs](https://developers.soxai.co.jp/api-reference/users/get-the-callers-own-ring-sync-logs.md): Read the caller's own ring synchronisation history: when their ring last uploaded data, and how much.
- [List the caller's groups](https://developers.soxai.co.jp/api-reference/family-groups/list-the-callers-groups.md): Every group the caller belongs to, with its creation time, roster size and **the caller's own sharing settings in that group** (SOX-67).
- [Create a family group](https://developers.soxai.co.jp/api-reference/family-groups/create-a-family-group.md): Create a family group with the caller as its first member and admin.
- [Get one family group](https://developers.soxai.co.jp/api-reference/family-groups/get-one-family-group.md): One group by id — the same keys as a `GET /api/groups` entry plus groupType and createdBy. Member *identity* comes with the entry (`members`, SOX-82); member *health data* lives in GroupView.
- [Rename a family group](https://developers.soxai.co.jp/api-reference/family-groups/rename-a-family-group.md): Rename a group.
- [Dissolve a family group](https://developers.soxai.co.jp/api-reference/family-groups/dissolve-a-family-group.md): Dissolve a group and every record under it: its roster, its invite codes and the group document itself. Members are not notified, and nothing is recoverable.
- [Issue a group invite link](https://developers.soxai.co.jp/api-reference/family-groups/issue-a-group-invite-link.md): Create an invite code for a group and return it as a deep link the recipient can open.
- [Join a family group with an invite code](https://developers.soxai.co.jp/api-reference/family-groups/join-a-family-group-with-an-invite-code.md): Join a group using the `groupId` and `code` carried by an invite deep link.
- [Get the caller's own membership in a group](https://developers.soxai.co.jp/api-reference/family-groups/get-the-callers-own-membership-in-a-group.md): The caller's own membership: displayName, role, masterHidden and the stored `sharedFields`.
- [Update the caller's own membership settings](https://developers.soxai.co.jp/api-reference/family-groups/update-the-callers-own-membership-settings.md): Update the caller's own display name and sharing settings **in this group**. Sharing is per membership, so the same account can share different metrics in different groups.
- [Leave a family group](https://developers.soxai.co.jp/api-reference/family-groups/leave-a-family-group.md): Remove the caller's own membership from a group.
- [Remove several members from a group](https://developers.soxai.co.jp/api-reference/family-groups/remove-several-members-from-a-group.md): Remove several members at once — the batch form of `DELETE /api/groups/{group_id}/members/{uid}`, which stays as-is for clients that remove one member at a time (SOX-64 item 3).
- [Remove one member from a group](https://developers.soxai.co.jp/api-reference/family-groups/remove-one-member-from-a-group.md): Remove a single member from a group's roster.
- [Change a member's role in a group](https://developers.soxai.co.jp/api-reference/family-groups/change-a-members-role-in-a-group.md): Promote a member to `admin` or demote them to `member`.
- [Get every member's reactions in a group](https://developers.soxai.co.jp/api-reference/family-groups/get-every-members-reactions-in-a-group.md): The reactions currently held on each member of the group (SOX-116).
- [Send a reaction to a member](https://developers.soxai.co.jp/api-reference/family-groups/send-a-reaction-to-a-member.md): Send one reaction to one member of the group (SOX-116).
- [Take back a reaction](https://developers.soxai.co.jp/api-reference/family-groups/take-back-a-reaction.md): Take back one reaction the caller sent to one member (SOX-116).
- [Get a family group's shared health data](https://developers.soxai.co.jp/api-reference/family-groups/get-a-family-groups-shared-health-data.md): The single data-view endpoint for family groups (spec §3.5). All masking goes through resolve_field_mask — no endpoint-local mask logic.
- [Resolve a group-invite deep link](https://developers.soxai.co.jp/api-reference/deep-links/resolve-a-group-invite-deep-link.md): Group-invite token resolution for mobile routing. Never consumes the token.
- [Generate a prefilled sign-up deep link](https://developers.soxai.co.jp/api-reference/deep-links/generate-a-prefilled-sign-up-deep-link.md): Generate a deep link that opens the SOXAI app with the given email address already filled in, for handing to a user who is being onboarded.
- [Exchange a prefill token for its email address](https://developers.soxai.co.jp/api-reference/deep-links/exchange-a-prefill-token-for-its-email-address.md): Return the email address carried by a login-prefill token, so the app can prefill its sign-up or login form from a deep link.
- [Glossary](https://developers.soxai.co.jp/glossary.md): How SOXAI uses company, organization, team, member, and family group.
- [Changelog](https://developers.soxai.co.jp/changelog.md): Changes to the public SOXAI API documentation and OpenAPI specification.
- [Support](https://developers.soxai.co.jp/support.md): Request production access or ask a question about the SOXAI API.

## OpenAPI Specs

- [openapi-public](/openapi-public.json)
- [openapi-sandbox](/openapi-sandbox.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.