Accounts & authentication

Read your data-sharing choice

GET /api/v1/account/data-sharing

Returns your data-sharing choice and its current wording. Sharing check data to help improve Commitscale is optional and off by default. Returns the responsible person's own plan and consent, including the accepted wording version and current wording. Earlier consents keep their accepted version until the person explicitly accepts the current one. A personal token, browser session, phone token, or regular agent, runner or job token can read the responsible person's choice. A check-only key cannot.

Example request

curl --request GET 'https://commitscale.com/api/v1/account/data-sharing' \
  --header "Authorization: Bearer $CSCALE_TOKEN"

Example values illustrate the format. Use your own credentials and identifiers.

Responses

200 The person's consent.

application/json

{
  "current_wording_version": "free-excerpts-2",
  "opted_in": false,
  "opted_in_at": "2026-10-26T10:00:00Z",
  "plan": "free",
  "withdrawn_at": "2026-10-26T10:00:00Z",
  "wording": "Help us improve Commitscale by sharing data from your checks, with secrets removed.",
  "wording_version": "free-excerpts-2"
}

current_wording_versionrequired · string: Version of the consent text currently offered by this server.
opted_inrequired · boolean: Whether the person explicitly chose to share scrubbed Free-plan check data.
opted_in_atrequired · string or null (date-time): When sharing was enabled, in UTC; null if never enabled.
planrequired · string: The person's own plan, independent of any selected organization.
withdrawn_atrequired · string or null (date-time): When sharing was withdrawn, in UTC; null if never withdrawn.
wordingrequired · string: The exact consent text to show before asking the person to choose.
wording_versionrequired · string or null: The wording last accepted by this person, if any.

RateLimit and RateLimit-Policy describe the request rate. Follow Retry-After when a response asks you to wait.

Problem responses

Errors use application/problem+json. Act on the stable code, and follow next when present. See the problem format.

check_key_scope403

A check-only key may call the test check, read its own usage and acceptance rule, contact support, and withdraw data sharing.

Use a person's sign-in for account management. More agent power needs the owner's passkey; this key cannot widen itself.

feature_off403

The namespace plan does not include this feature.

Retrying on the same plan will not help. GET /api/v1/namespaces/{namespace}/plan, and the namespace's Plan page in Settings, show what its plan includes.

unauthenticated401

The request carried no credentials.

Use this operation's sign-in method. Bearer credentials use Authorization: Bearer <token>; browser credentials use the session cookie.

invalid_token401

The token is unknown, expired, or revoked, its agent was revoked, or an OAuth token was used outside its MCP resource.

Stop using it. Sign in again, or ask the owner to create a replacement agent key.

forbidden403

The caller may not do this: only people may, only owners may, or the agent was not given this repository or write access.

Stop. Retrying will not help. Ask the owner for the access, or leave the step to a person.

quota_exceeded429

With 429, the caller used its requests for the minute. With 422, a count limit was reached.

With 429, wait Retry-After seconds and retry. With 422, remove one first.

internal500

The server failed, and logged why.

Retry after Retry-After seconds. A write is safe to retry with the same idempotency key.