Menu

Architecture

About this API Domains Versioning Example URLs

General

Identifiers Supported Data Formats Data Types
Requests
Access Token and Related Information Localization GET Request Query Parameter Collection Requests POST/PATCH Request Body
Responses
Content Type Response Codes Response Body Error Responses Standard Responses

Authentication and Authorization

Partner Authentication User Authorization
Authorization Code Grant (GET /oauth2/auth)
Request query parameters Example 1: Requesting the diary scope Example 2: Requesting all available scopes Response Authorization Errors
Access Token Request (POST /oauth2/token)
Request body form parameters Response Access Token Errors
Refreshing Access Tokens (POST /oauth2/token)
Request body form parameters Response Refresh Token Errors Making Requests
Revoking Tokens (POST /oauth2/revoke)
Request body form parameters Response

Users

Resources GET /users/:userId
Example Response with no fields parameter Example Response with fields elements
Resources PATCH /users/:userId
Request Example

Measurements

Resources
GET /measurements/ POST /measurements/

Diary

Resources
GET /diary/ POST /diary/ PATCH /diary/ DELETE /diary/

Exercises

Resources
GET /exercises/

Subscriptions

Management
POST /subscription/ GET /subscription/ PATCH /subscription/ DELETE /subscription/
Notifications
Example Request Body Best Design Practices

Appendix

Data Structures
User Measured Value User Profile Account Privacy Preferences Goal Preferences Location Preferences Diary Preferences Nutritional Contents Exercise Measurement Diary Subscription
Error Codes
Error Codes
Migrating from MyFitnessPal API v1 to v2
v1 action: log_cardio_exercise v1 action: remove_cardio_exercise v1 action: log_weight v1 action: log_expended_energy v1 action: get_food_summary v1 action: get_cardio_exercises v1 action: get_weight v1 action: fetch_user_info v1 action: subscribe_to_user_updates v1 action: unsubscribe_from_user_updates
Tracking all­day steps activity
Tracking all-day steps activity Recommended approach for tracking steps Determining daily totals Calorie Adjustments
MyFitnessPal exercises and their identifiers
MyFitnessPal exercises and their identifiers
Full request and response examples
POST and GET request and response

Measurements

The following resource structure definition is relevant for this set of endpoints:

● Measurement

GET ​/measurements/​:measurementId

Required permission scope: ​measurements

Retrieves the measurement with the given identifier, provided the user identified by the mfp-user-id​ header is authorized to access it.

Example response

{
    "item": {
      "id": "s09feu438vfn3kgh",
      "type": "weight",
      "value": 208,
      "unit": "pounds",
      "date": "2014-04-16",
      "updated_at": "2014-05-06T08:30:05-07:00"
    }
}

Required permission scope: ​measurements

Retrieves a set of measurements for the logged­in user, whose id is the value of the mfp-user-id​ header. Measurements are retrieved for a single entry date, and may be narrowed by measurement type.

GET ​/measurements

Request query parameters

Name Description Type Required Sample Values
entry_date Measurement creation date to search for, in ISO 8601 format: YYYY-MM-DD. Date Y 2014-05-15
types A comma-delimited list of measurement types to include. String N weight

Currently, “weight” is the only supported measurement type.

## Response

The response is an ordered list of measurements matching the request parameters. Pagination rules apply in the event of many measurements created on a the same date.