Skip to main content

Get Nutrition Settings (v1)

Method & Path

GET /api/v1/workspace/:workspaceId/nutrition/settings

Description

Retrieves the nutrition module settings for the workspace. Creates default settings if none exist.

Authentication

Required: Workspace token with nutrition view permission.

Headers

HeaderRequiredDescription
AuthorizationYesBearer <token>

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID

Response 200 OK

{
"settings": {
"id": "507f1f77bcf86cd799439015",
"workspaceId": "507f1f77bcf86cd799439012",
"specialistSlug": "dr-ahmed-nutrition",
"businessName": "عيادة د. أحمد للتغذية",
"measurementUnits": "metric",
"defaultCurrency": "ILS",
"branding": {
"logoUrl": "https://storage.placio.app/logos/clinic.png",
"primaryColor": "#10b981",
"welcomeMessage": "مرحباً بك في بوابة التغذية"
},
"portalOptions": {
"allowDiaryEntry": true,
"allowProgressEntry": true,
"showCalories": true,
"showMacros": true,
"showSessions": true
},
"defaultDailyCalories": 2000,
"defaultMacros": {
"protein": 100,
"carbs": 250,
"fats": 65
},
"mealNames": ["فطور", "غداء", "عشاء", "وجبة خفيفة"],
"workingDays": [0, 1, 2, 3, 4],
"sessionDuration": 30,
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z"
}
}

Settings Fields

FieldTypeDescription
specialistSlugstringUnique URL slug for client portal
businessNamestringDisplay name in portal
measurementUnitsstring"metric" or "imperial"
brandingobjectPortal branding settings
portalOptionsobjectFeatures enabled for clients
mealNamesstring[]Default meal names
workingDaysnumber[]Working days (0=Sunday)
sessionDurationnumberDefault session duration in minutes

Common Errors

  • 401 Unauthorized: Missing or invalid token
  • 404 Not Found: Workspace not found