Skip to main content

Preferences API

Manage user-specific application preferences.

Endpoints Overview​

MethodEndpointDescription
GET/preferences/me/preferencesGet my preferences
PATCH/preferences/me/preferencesUpdate my preferences

Get Preferences​

GET /preferences/me/preferences

Retrieve the current user's preferences (e.g., notifications, UI settings).

Response​

{
  "user_id": "uuid-of-user",
  "notifications": {
    "email_frequency": "immediate",
    "slack_enabled": true
  },
  "ui": {
    "theme": "dark",
    "density": "compact"
  }
}

Update Preferences​

PATCH /preferences/me/preferences

Update specific preference settings.

Request Body​

{
  "notifications": {
    "email_frequency": "daily"
  }
}

Response​

Returns the updated preference object.