Fitbit

The Log Activity endpoint creates log entry for an activity or user's private custom activity using units in the unit system which corresponds to the Accept-Language header provided (or using optional custom distanceUnit) and get a response in the format requested.

Adds the alarm settings to a given ID for a given device.

Creates a log entry for body fat and returns a response in the format requested.

Adds the activity with the given ID to user's list of favorite activities.

Updates a user's daily activity goals and returns a response using units in the unit system which corresponds to the Accept-Language header provided.

Creates a new private food for a user and returns a response in the format requested. The created food is found via the Search Foods call.

Creates food log entries for users with or without foodId value.

Creates a meal with the given food contained in the post body.

Creates a log entry for a sleep event and returns a response in the format requested.

Adds a subscription in your application so that users can get notifications and return a response in the format requested. The subscription-id value provides a way to associate an update with a particular user stream in your application.

Updates a user's daily or weekly activity goals and returns a response using units in the unit system which corresponds to the Accept-Language header provided.

Updates a user's daily calories consumption goal or food plan and returns a response in the format requested.

Updates a user's daily calories consumption goal or food plan and returns a response in the format requested.

Creates a log entry for water using units in the unit systems that corresponds to the Accept-Language header provided.

Creates log entry for a body weight using units in the unit systems that corresponds to the Accept-Language header provided and gets a response in the format requested.

Deletes a user's activity log entry with the given ID.

Deletes the user's device alarm entry with the given ID for a given device.

Deletes a user's body fat log entry with the given ID.

Removes the activity with the given ID from a user's list of favorite activities.

Deletes a food with the given ID to the user's list of favorite foods.

Deletes custom food for a user and returns a response in the format requested.

Deletes a user's food log entry with the given ID.

Deletes a user's meal with the given meal id.

Deletes a user's sleep log entry with the given ID.

Deletes a subscription for a user..

Deletes a user's water log entry with the given ID.

Deletes a user's body weight log entrywith the given ID.

The Edit Food Log endpoint changes the quantity or calories consumed for a user's food log entry with the given Food Log ID.

Retrieves a summary and list of a user's activities and activity log entries for a given day.

Retreives a user's current daily or weekly activity goals using measurement units as defined in the unit system, which corresponds to the Accept-Language header provided.

Updates a user's daily activity goals and returns a response using units in the unit system which corresponds to the Accept-Language header provided.

Retreives a list of user's activity log entries before or after a given day with offset and limit using units in the unit system which corresponds to the Accept-Language header provided.

Returns the Intraday Time Series for a given resource in the format requested.

Returns time series data in the specified range for a given resource in the format requested using units in the unit system that corresponds to the Accept-Language header provided.

Returns activities time series data in the specified range for a given resource.

Returns the Activity Intraday Time Series for a given resource in the format requested.

Returns the Intraday Time Series for a given resource in the format requested.

Returns the Intraday Time Series for a given resource in the format requested.

Retreives the details of a user's location and heart rate data during a logged exercise activity.

Returns time series data in the specified range for a given resource in the format requested using units in the unit system that corresponds to the Accept-Language header provided.

Returns time series data in the specified range for a given resource.

Returns the detail of a specific activity in the Fitbit activities database in the format requested. If activity has levels, it also returns a list of activity level details.

Retreives a tree of all valid Fitbit public activities from the activities catelog as well as private custom activities the user created in the format requested.

Returns alarms for a device

Returns the active zone minutes intraday data for a 24 hour period by specifying a date and/or time range.

Returns the active zone minutes intraday data for a 24 hour period by specifying a date and/or time range.

Returns the active zone minutes intraday data for a 24 hour period by specifying a date range and/or time range.

Returns the active zone minutes intraday data for a 24 hour period by specifying a date range and/or time range.

Returns the daily summary values over a period of time by specifying a date and time period.

Returns the daily summary values over an interval by specifying a date range.

Retrieves the user's badges in the format requested. Response includes all badges for the user as seen on the Fitbit website badge locker (both activity and weight related.) The endpoint returns weight and distance badges based on the user's unit profile preference as on the website.

Retreives a list of all user's body fat log entries for a given day in the format requested.

Retreives a list of all user's body fat log entries for a given day in the format requested.

Retreives a list of all user's body fat log entries for a given day in the format requested.

Retreives a user's current body fat percentage or weight goal using units in the unit systems that corresponds to the Accept-Language header providedin the format requested.

Returns time series data in the specified range for a given resource in the format requested using units in the unit system that corresponds to the Accept-Language header provided.

Returns time series data in the specified range for a given resource in the format requested using units in the unit system that corresponds to the Accept-Language header provided.

This endpoint returns intraday breathing rate data for a single date. It measures the average breathing rate throughout the day and categories your breathing rate by sleep stage. Sleep stages vary between light sleep, deep sleep, REM sleep, and full sleep.

This endpoint returns intraday breathing rate data for a date range. It measures the average breathing rate throughout the day and categories your breathing rate by sleep stage. Sleep stages vary between light sleep, deep sleep, REM sleep, and full sleep.

This endpoint returns average breathing rate data for a single date. Breathing Rate data applies specifically to a user’s “main sleep,” which is the longest single period of time during which they were asleep on a given date.

This endpoint returns average breathing rate data for a date range. Breathing Rate data applies specifically to a user’s “main sleep,” which is the longest single period of time during which they were asleep on a given date.

Returns a list of the Fitbit devices connected to a user's account.

This endpoint is used for querying the user's on-device ECG readings.

Returns a list of a user's favorite activities.

Returns a list of a user's favorite foods in the format requested. A favorite food in the list provides a quick way to log the food via the Log Food endpoint.

Retreives a summary and list of a user's food log entries for a given day in the format requested.

Updates a user's daily activity goals and returns a response using units in the unit system which corresponds to the Accept-Language header provided.

Returns a user's current daily calorie consumption goal and/or foodPlan value in the format requested.

Returns the details of a specific food in the Fitbit food databases or a private food that an authorized user has entered in the format requested.

Returns a list of public foods from the Fitbit food database and private food the user created in the format requested.

Returns the food locales that the user may choose to search, log, and create food in.

Updates a user's daily activity goals and returns a response using units in the unit system which corresponds to the Accept-Language header provided.

Returns a list of all valid Fitbit food units in the format requested.

Retreives a list of a user's frequent activities in the format requested using units in the unit system which corresponds to the Accept-Language header provided.

Returns a list of a user's frequent foods in the format requested. A frequent food in the list provides a quick way to log the food via the Log Food endpoint.

Returns data of a user's friends in the format requested using units in the unit system which corresponds to the Accept-Language header provided.

Returns data of a user's friends in the format requested using units in the unit system which corresponds to the Accept-Language header provided.

Returns the intraday time series for a given resource in the format requested. If your application has the appropriate access, your calls to a time series endpoint for a specific day (by using start and end dates on the same day or a period of 1d), the response will include extended intraday values with a one-minute detail level for that day. Unlike other time series calls that allow fetching data of other users, intraday data is available only for and to the authorized user.

Returns the time series data in the specified range for a given resource in the format requested using units in the unit systems that corresponds to the Accept-Language header provided.

Returns the time series data in the specified range for a given resource in the format requested using units in the unit systems that corresponds to the Accept-Language header provided.

Returns the intraday time series for a given resource in the format requested. If your application has the appropriate access, your calls to a time series endpoint for a specific day (by using start and end dates on the same day or a period of 1d), the response will include extended intraday values with a one-minute detail level for that day. Unlike other time series calls that allow fetching data of other users, intraday data is available only for and to the authorized user.

Returns the intraday time series for a given resource in the format requested. If your application has the appropriate access, your calls to a time series endpoint for a specific day (by using start and end dates on the same day or a period of 1d), the response will include extended intraday values with a one-minute detail level for that day. Unlike other time series calls that allow fetching data of other users, intraday data is available only for and to the authorized user.

Returns the intraday time series for a given resource in the format requested. If your application has the appropriate access, your calls to a time series endpoint for a specific day (by using start and end dates on the same day or a period of 1d), the response will include extended intraday values with a one-minute detail level for that day. Unlike other time series calls that allow fetching data of other users, intraday data is available only for and to the authorized user.

This endpoint returns the Heart Rate Variability (HRV) intraday data for a single date. HRV data applies specifically to a user’s “main sleep,” which is the longest single period of time asleep on a given date.

This endpoint returns the Heart Rate Variability (HRV) intraday data for a single date. HRV data applies specifically to a user’s “main sleep,” which is the longest single period of time asleep on a given date.

This endpoint returns the Heart Rate Variability (HRV) data for a single date. HRV data applies specifically to a user’s “main sleep,” which is the longest single period of time asleep on a given date.

This endpoint returns the Heart Rate Variability (HRV) data for a date range. HRV data applies specifically to a user’s “main sleep,” which is the longest single period of time asleep on a given date.

This endpoint returns a paginated list of Irregular Rhythm Notifications (IRN) alerts, as well as all of the alert tachograms. This endpoint will only return alerts that the user has read in the Fitbit app already, as that is meant as the primary entrypoint for viewing notifications.

This endpoint returns the user state for Irregular Rhythm Notifications (IRN). The user state contains most information about the user’s current engagement with the feature, including onboarding progress and algorithm processing state.

Returns a list of meals created by user in the user's food log in the format requested. User creates and manages meals on the Food Log tab on the website.

Returns a user's profile. The authenticated owner receives all values. However, the authenticated user's access to other users' data is subject to those users' privacy settings. Numerical values are returned in the unit system specified in the Accept-Language header.

Retreives a list of a user's recent activities types logged with some details of the last activity log of that type using units in the unit system which corresponds to the Accept-Language header provided.

Returns a list of a user's frequent foods in the format requested. A frequent food in the list provides a quick way to log the food via the Log Food endpoint.

The Get Sleep Logs by Date endpoint returns a summary and list of a user's sleep log entries (including naps) as well as detailed sleep entry data for a given day.

The Get Sleep Logs by Date Range endpoint returns a list of a user's sleep log entries (including naps) as well as detailed sleep entry data for a given date range (inclusive of start and end dates).

Returns the user's sleep goal.

The Get Sleep Logs List endpoint returns a list of a user's sleep logs (including naps) before or after a given day with offset, limit, and sort order.

This endpoint returns the SpO2 intraday data for a single date. SpO2 applies specifically to a user’s “main sleep”, which is the longest single period of time asleep on a given date.

This endpoint returns the SpO2 intraday data for a specified date range. SpO2 applies specifically to a user’s “main sleep”, which is the longest single period of time asleep on a given date.

This endpoint returns the SpO2 summary data for a single date. SpO2 applies specifically to a user’s “main sleep”, which is the longest single period of time asleep on a given date.

This endpoint returns the SpO2 summary data for a date range. SpO2 applies specifically to a user’s “main sleep”, which is the longest single period of time asleep on a given date.

Retreives a list of a user's subscriptions for your application in the format requested. You can either fetch subscriptions for a specific collection or the entire list of subscriptions for the user. For best practice, make sure that your application maintains this list on your side and use this endpoint only to periodically ensure data consistency.

Returns the Temperature (Core) data for a single date. Temperature (Core) data applies specifically to data logged manually by the user throughout the day.

Returns Temperature (Core) data for a date range. Temperature (Core) data applies specifically to data logged manually by the user throughout the day and the maximum date range cannot exceed 30 days.

Returns Temperature (Skin) data for a date range. It only returns a value for dates on which the Fitbit device was able to record Temperature (skin) data and the maximum date range cannot exceed 30 days.

Returns the Temperature (Skin) data for a single date. Temperature (Skin) data applies specifically to a user’s “main sleep”, which is the longest single period of time asleep on a given date.

This endpoint returns the Cardio Fitness Score (VO2 Max) data for a single date. VO2 Max values will be shown as a range if no run data is available or a single numeric value if the user uses a GPS for runs.

This endpoint returns the Cardio Fitness Score (VO2 Max) data for a date range. VO2 Max values will be shown as a range if no run data is available or a single numeric value if the user uses a GPS for runs.

Retreives a summary and list of a user's water log entries for a given day in the requested using units in the unit system that corresponds to the Accept-Language header provided.

Retreives a summary and list of a user's water goal entries for a given day in the requested using units in the unit system that corresponds to the Accept-Language header provided.

Retreives a list of all user's body weight log entries for a given day using units in the unit systems which corresponds to the Accept-Language header provided.

Retreives a list of all user's body weight log entries for a given day in the format requested.

Retreives a list of all user's body fat log entries for a given day in the format requested.

Retrieves the active state of an OAuth 2.0 token. It follows https://tools.ietf.org/html/rfc7662.

Retrieves an OAuth 2 access token.

Revokes consent of the access token or refresh token

Updates the alarm entry with a given ID for a given device. It also gets a response in the format requested.

Updates user's fat percentage goal.

Replaces an existing meal with the contents of the request. The response contains the updated meal.

Create or update the user's sleep goal and get a response in the JSON format.

Updates a user's water log entry with the given ID.

Updates user's fat percentage goal.