Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api.docs.onlydrams.app/llms.txt

Use this file to discover all available pages before exploring further.

Retrieves all user settings for a specific category, including their current values and descriptions.

Endpoint

GET /api/v2/users/:id/settings/:category

Parameters

id
string
required
The ID of the user whose settings to retrieve (must be the authenticated user).
category
string
required
The category of settings to retrieve (e.g., “privacy”, “notifications”, “display”, “security”).
curl -X GET https://api.onlydrams.app/api/v2/users/123e4567-e89b-12d3-a456-426614174000/settings/privacy \
  -H "Authorization: Bearer $ACCESS_TOKEN"
[
  {
    "key": "public_profile",
    "value": "true",
    "category": "privacy",
    "title": "Public Profile",
    "description": "Allow other users to view your profile"
  },
  {
    "key": "show_email",
    "value": "false",
    "category": "privacy",
    "title": "Show Email",
    "description": "Display your email address on your profile"
  },
  {
    "key": "show_location",
    "value": "true",
    "category": "privacy",
    "title": "Show Location",
    "description": "Display your location on your profile"
  }
]
curl -X GET https://api.onlydrams.app/api/v2/users/123e4567-e89b-12d3-a456-426614174000/settings/notifications \
  -H "Authorization: Bearer $ACCESS_TOKEN"
[
  {
    "key": "email_notifications",
    "value": "true",
    "category": "notifications",
    "title": "Email Notifications",
    "description": "Receive email notifications for important updates"
  },
  {
    "key": "push_notifications",
    "value": "false",
    "category": "notifications",
    "title": "Push Notifications",
    "description": "Receive push notifications on your device"
  },
  {
    "key": "marketing_emails",
    "value": "true",
    "category": "notifications",
    "title": "Marketing Emails",
    "description": "Receive promotional emails and newsletters"
  }
]

Error Responses

{
  "error": "You can only view your own settings"
}
{
  "error": "User not found"
}
{
  "error": "Category not found"
}

Notes

  • For the public_profile setting in the security category, the value is inverted for UI consistency
  • Each setting includes a title and description for better user understanding
  • Invalid categories will result in a 404 error