Get Body Goals

Retrieves a user's body fat and weight goals.

Scope: weight

Request

GET	/1/user/[user-id]/body/log/[goal-type]/goal.json

URI Arguments

user-id	required	The encoded ID of the user. Use "-" (dash) for current logged-in user.
goal-type	required	Supported: `weight` \| `fat`

Request Headers

authorization	required	Specify the token type and Fitbit user’s access token. Token type: `Bearer`
accept	optional	The media type of the response content the client is expecting. Supported: `application/json`
accept-language	optional	The measurement unit system to use for response values. See Localization.
accept-locale	optional	The locale to use for response values. See Localization.

Examples

URL
CURL

GET https://api.fitbit.com/1/user/-/body/log/weight/goal.json
GET https://api.fitbit.com/1/user/GGNJL9/body/log/weight/goal.json

curl -X GET "https://api.fitbit.com/1/user/-/body/log/weight/goal.json" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"

Element Name	Description
goal : goalType	The goal type. Supported: `LOSE` \| `GAIN` \| `MAINTAIN`
goal : startDate	The goal start date.
goal : startWeight	User's weight when goal was established.
goal : weight	The weight goal to achieve.
goal : weightThreshold	The recommended amount of weight to lose each week to achieve and maintain goal.
goal : fat	The body fat goal to achieve.

Weight Goal
{
  "goal": {
    "goalType": "LOSE",
    "startDate": "2018-06-13",
    "startWeight": 105.28,
    "weight": 99.79,
    "weightThreshold": 0.05
  }
}

Body Fat Goal
{
  "goal": {
    "fat": 25
  }
}

Response Headers

content-type	The media type of the response content being sent to the client. Supported: `application/json`
fitbit-rate-limit-limit	The quota number of calls.
fitbit-rate-limit-remaining	The number of calls remaining before hitting the rate limit.
fitbit-rate-limit-reset	The number of seconds until the rate limit resets.

Note: The rate limit headers are approximate and asynchronously updated. This means that there may be a minor delay in the decrementing of remaining requests. This could result in your application receiving an unexpected 429 response if you don't track the total number of requests you make yourself.

Response Type

HTTP Status Code	HTTP response code. List of codes are found in the Troubleshooting Guide.
Status Message	Description of the status code.
Response Body	Contains the JSON response to the API call. When errors are returned by the API call, the errorType, fieldName and message text will provide more information to the cause of the failure.

Response Codes

200	A successful request.
400	The request had bad syntax or was inherently impossible to be satisfied.
401	The request requires user authentication.

Note: For a complete list of response codes, please refer to the Troubleshooting Guide.

Delete Weight Log

Get Body Fat Log