Skip to main content

​
Settings API

/settings/* endpoints are user-account APIs, not workspace APIs.

​
Authentication model

  • Session auth only (API keys are not supported).
  • Intended for authenticated dashboard users.

​
Endpoint matrix

MethodPathPurpose
GET/settings/profileRead user profile (id, email, name, image, verification state, default workspace)
PUT/settings/profileUpdate name and/or image
POST/settings/request-email-changeStart secure email-change workflow
PUT/settings/default-workspaceSet dashboard default workspace

​
Email-change security flow

POST /settings/request-email-change uses hybrid checks:
  • credential users must provide current password
  • social-only users can proceed without password
  • verification email is sent to the new address
  • email changes only after verification is completed
Common error outcomes:
  • 400 PASSWORD_REQUIRED
  • 401 INVALID_PASSWORD
  • 409 EMAIL_TAKEN

​
Default workspace behavior

PUT /settings/default-workspace validates that:
  • target workspace exists
  • user is still an active member
If validation passes, subsequent dashboard loads use the new workspace by default. Related docs:
  • /user-guides/manual/workspace/settings-and-preferences
  • /user-guides/manual/workspace/security-and-compliance
  • /user-guides/manual/workspace/workspaces-and-access