Make your product
work with UP.

Settings

Get the user settings on UP

Returns the settings user has set on UP. Read only, user settings cannot be written via the API at this time.

Data returned for privacy settings is controlled by the scopes meal_read, sleep_read, weight_read, mood_read, and move_read. The returned result will be filtered based on the scope that user token has for your application. For example if your token only has the scope sleep_read then only the privacy setting for sleep data will be returned. If the token has all the scopes then the complete settings data set will be returned.
URI Method Response Type Returns
/nudge/api/v.1.1/users/@me/settings GET application/json Goals

Example:

GET https://jawbone.com/nudge/api/v.1.1/users/@me/settings HTTP/1.1
Host: jawbone.com
	

Will return:

HTTP 200 OK
{
   "meta": 
   {
      "user_xid": "6xl39CsoVp2KirfHwVq_Fx",
      "message": "OK",
      "code": 200
      "time": 1382377526
   },
   "data":
   {
      "xid": "6xl39CsoVp23n75TIckPLQ", 
      "metric": 0,
      "share_sleep": true, 
      "share_mood": true, 
      "share_body": false, 
      "share_eat": true, 
      "goals": 
      {
         "move": 
         {
            "steps": 10000
         }, 
         "sleep": 
         {
            "total": 23400
         }
      }, 
   }
}
	
Data Value Type Description
XID string Unique ID for user.
metric int User setting for units. 0 = Imperial (American) system, 1 = Metric system
share_sleep boolean Whether the user shares sleep events with their teammates. Requires sleep_read scope.
share_mood boolean Whether the user shares mood events with their teammates. Requires mood_read scope.
share_body boolean Whether the user shares body events with their teammates. Requires weight_read scope.
share_eat boolean Whether the user shares meal events with their teammates. Requires meal_read scope.
share_move boolean Whether the user shares move events with their teammates. Requires move_read scope.