Skip to content

The settings object

Your daily targets over time, display preferences and body measurements.

Settings hold what your days are measured against: daily calorie and macro targets, the units to show amounts in, and body measurements. Both settings endpoints return them in this shape.

{
"targets": [
{ "startsOn": "2026-09-01", "values": { "caloriesKcal": 2200, "proteinG": 130, "carbsG": 250, "fatG": 70 } },
{ "startsOn": "2026-10-01", "values": { "caloriesKcal": 2000, "proteinG": 130, "carbsG": 220, "fatG": 65 } }
],
"preferences": { "units": null, "deviceUnits": "metric", "showTargets": true, "assistantShortcut": "chatgpt" },
"body": { "weightKg": 76, "heightCm": 175, "age": 34, "sex": "male", "activity": "somewhat" }
}
FieldTypeDescription
targetsarrayYour daily targets over time, oldest first. Each period applies from startsOn until the next one.
preferencesobjectDisplay preferences.
bodyobjectBody measurements, each null until set.

Targets are kept as periods, so past days keep the targets they had. A period applies from its startsOn until the next one starts. To find the targets for a day, take the last period that starts on or before it; with none, or with values set to null, that day has no targets.

FieldTypeDescription
startsOndateThe first day of the period.
valuesobject or nullThe targets in the period, or null for none.

Targets are always kilocalories and grams, whatever units says. To see how a day went, compare them with the nutrition of that day’s meals.

FieldTypeDescription
caloriesKcalnumberEnergy, in kcal.
proteinGnumberProtein, in grams.
carbsGnumberCarbohydrates, in grams.
fatGnumberFat, in grams.
FieldTypeDescription
unitsstring or nullThe units to show amounts in; imperial is US customary. null follows the phone. One of metric, imperial or uk.
deviceUnitsstring or nullThe units the phone uses, as the app last reported them. One of metric, imperial or uk.
showTargetsbooleanWhether the app shows progress towards your targets.
assistantShortcutstring or nullThe assistant the app's shortcut opens, or off. One of claude, chatgpt or off.
FieldTypeDescription
weightKgnumber or nullWeight, in kilograms.
heightCmnumber or nullHeight, in centimetres.
ageinteger or nullAge, in years. From 1 to 130.
sexstring or nullSex, for estimating energy needs. One of female, male or unspecified.
activitystring or nullHow active a usual day is. One of sitting, somewhat or very.

Last updated