Get Meals
Retrieves a list of meals created by the user from their food log.
Scope: nutrition
Request
GET | /1/user/[user-id]/meals.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/-/meals.json
GET https://api.fitbit.com/1/user/GGNJL9/meals.json
GET https
curl -X GET "https://api.fitbit.com/1/user/-/meals.json" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"
Response
Element Name | Description |
meals : description | |
meals : id | |
meals : mealFoods : accessLevel | |
meals : mealFoods : amount | |
meals : mealFoods : brand | |
meals : mealFoods : calories | |
meals : mealFoods : foodId | |
meals : mealFoods : locale | |
meals : mealFoods : mealTypeId | |
meals : mealFoods : name | |
meals : mealFoods : unit : id | |
meals : mealFoods : unit : name | |
meals : mealFoods : unit : plural | |
meals : mealFoods : units | |
meals : name |
{ "meals": [ { "description": "", "id": 250763687, "mealFoods": [ { "accessLevel": "PUBLIC", "amount": 1, "brand": "", "calories": 774, "foodId": 28395, "locale": "en_US", "mealTypeId": 7, "name": "Ground Beef, Broiled, 95% Lean", "unit": { "id": 180, "name": "lb", "plural": "lbs" }, "units": [ 238, 226, 180, 147, 389 ] }, { "accessLevel": "PUBLIC", "amount": 1, "brand": "Southern valley", "calories": 30, "foodId": 727995344, "locale": "en_US", "mealTypeId": 7, "name": "Bell Pepper", "unit": { "id": 304, "name": "serving", "plural": "servings" }, "units": [ 304, 226, 180, 147, 389 ] }, { "accessLevel": "PUBLIC", "amount": 1, "brand": "", "calories": 53, "foodId": 81002, "locale": "en_US", "mealTypeId": 7, "name": "Onion", "unit": { "id": 204, "name": "medium", "plural": "mediums" }, "units": [ 288, 316, 311, 319, 204, 179, 304, 349, 364, 91, 256, 279, 226, 180, 147, 389 ] } ], "name": "Spaghetti" } ] }
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
Meals in the list provide a quick way to log several foods at a time via the calls to the Create Food Log endpoint.
Considerations
- The units field contains references to respective Food Units.
- The accessLevel field can be PUBLIC or PRIVATE. Sharing custom foods is not supported.
- The mealTypeId field is always 7 (Anytime). Meals are not associated with particular times.
Access Levels
There are 2 access level types for food log entries that an authorized user can view via API requests. Each food is annotated with an accessLevel field with one of the following values:
- PUBLIC - Foods that are in Fitbit's public food database and are visible to any Fitbit users. Only Fitbit populates this database to avoid spam and duplicate entries.
- PRIVATE - Foods created by a user either on the website or via the Create Food endpoint.