Get Food Goals
Retrieves the user's current daily calorie consumption goal and/or food plan.
Scope: nutrition
Request
| GET | /1/user/[user-id]/foods/log/goal.json |
URI Arguments
| user-id | required | The encoded ID of the user. Use "-" (dash) for current logged-in user. |
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
GET https://api.fitbit.com/1/user/-/foods/log/goal.json
GET https://api.fitbit.com/1/user/GGNJL9/foods/log/goal.json
GET https
curl -X GET "https://api.fitbit.com/1/user/-/foods/log/goal.json" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"
Response
| Element Name | Description |
| goals : calories | The daily calorie consumption goal. |
{
"goals": {
"calories": 2910
}
}
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.
Additional Information
Considerations
- If the Food Plan feature is not enabled, then the foodPlan value is not included.
- The calories value consists of either manual calorie target or the user's calorie goal according to their Food Plan, where the Food Plan is enabled.
- Estimated calorie consumption for the day is retrieved via the Get Food Log endpoint.
