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

Responses - Response Codes

Each response includes a standard HTTP status code to indicate the status of the request. Some API endpoints document the status codes they expect to return, but clients can reasonably expect each API endpoint to include any of the following status codes:

Success Codes Description
200 OK Typically in response to GET requests, indicates a successful request.
201 Created Typically in response to POST requests, indicates the successful creation of a new resource. The response includes the URI of the newly-created resource in a Location​ header, and may include a representation of the resource in the body. The resource may be requested via GET at the URI included in the ​Location header, though if the response body includes a representation of the resource, such a retrieval should be unnecessary.
202 Accepted The request succeeded, but processing has not been completed. Provided when a client does not require information about any resources created by the request, such as the submission of analytics data. Responses with this status will not contain a ​Location​ header for any created resources.
204 No Content Typically in response to PATCH and DELETE requests, indicates that the request completed, but the response body need not contain any information about the resource. This is because the client’s and server’s views of the resource are identical after the request completes, or because (in the case of DELETE) the resource no longer exists.
Redirection Description
302 Found The requested resource temporarily lives under a different URL or URI. A response with this code includes a ​Location​ header, which indicates where the desired resource may be found.
Client Error Codes Description
400 Bad Request The request has malformed syntax. The client should not repeat the request without changing something.
401 Unauthorized The request requires user authentication. Response will include a WWW-Authenticate​ header; if the request already included an ​Authorization header, then this response code indicates a refusal, and the client should not repeat the request without changing something. This will happen if the access token in the header is invalid, mismatched, or expired.
404 Not Found The requested resource was not found.
405 Method Not Allowed The HTTP method used in the request is not permitted on the resource. Responses must include an ​Allow​ header containing a list of HTTP methods allowed on the resource.
422 Unprocessable Entity Occurs when the content of a POST, PATCH, or PUT request fails validation.
429 Too Many Requests The client has sent too many requests in a given amount of time. The response will include a ​Retry-After​ header indicating how long the client should wait before making a new request, the value of which is a number of seconds. Example: Retry-After: 120
Client Error Codes Description
500 Internal Server Error The server encountered an unexpected error.
503 Service Unavailable The server is temporarily unavailable. When a response contains this status code, clients should wait for some time (at least two minutes) before attempting the request again.