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
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/ 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

Subscription Management

The process of setting up a partner client to receive subscription updates will include configuration of the URL to which notifications should be sent (via HTTP POST), as well as configuration of the types of items for which the client wishes to receive notifications. The types of items that may be subscribed to are:

Name Description
diary_meal Receive a notification when the user creates a food diary entry
diary_exercise Receive a notification when the user creates an exercise diary entry
diary_steps Receive a notification when the user’s daily step tracking is updated
measurements Receive a notification when the user creates a supported measurement, e.g., weight
user_info Receive a notification when the user updates relevant profile or account information

More item types may be added as features evolve.

POST ​/subscriptions

Required permission scope: ​subscriptions

Creates one or more subscriptions to item updates by the user identified by the value of the mfp-user-id​ header for the client identified by the value of the m​fp-client-id​ header.

Request

The request body must be empty. (This means that subscriptions to all content types will be created.)

Response

A successful response will include:

● a ​Location​ header with the URI of the first newly­created subscription
● a list of all the newly­created subscriptions, as they would be returned by a GET request.