Get Badges

Retrieves a list of the user’s badges.

Scope: profile

Request

GET	/1/user/[user-id]/badges.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	Defines 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

URL
CURL

GET https://api.fitbit.com/1/user/-/badges.json
GET https://api.fitbit.com/1/user/GGNJL9/badges.json

curl -X GET "https://api.fitbit.com/1/user/-/badges.json" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"

Element Name	Description
badges : badgeGradientEndColor
badges : badgeGradientStartColor
badges : badgeType	Type of badge received.
badges : category
badges : cheers
badges : dateTime	Date the badge was achieved.
badges : description
badges : earnedMessage
badges : encodedId
badges : image100px
badges : image125px
badges : image300px
badges : image50px
badges : image75px
badges : marketingDescription
badges : mobileDescription
badges : name
badges : shareImage640px
badges : shareText
badges : shortDescription
badges : shortName
badges : timesAchieved	Number of times the user has achieved the badge.
badges : unit	Units of meaure based on localization settings.
badges : value	The badge goal in the unit measurement.

{
  "badges": [
    {
      "badgeGradientEndColor": "FF677C",
      "badgeGradientStartColor": "D24958",
      "badgeType": "DAILY_STEPS",
      "category": "Daily Steps",
      "cheers": [],
      "dateTime": "2016-07-17",
      "description": "35,000 steps in a day",
      "earnedMessage": "Congrats on earning your first Hiking Boot badge!",
      "encodedId": "GGNJL9",
      "image100px": "https://static0.fitbit.com/images/badges_new/100px/badge_daily_steps35k.png",
      "image125px": "https://static0.fitbit.com/images/badges_new/125px/badge_daily_steps35k.png",
      "image300px": "https://static0.fitbit.com/images/badges_new/300px/badge_daily_steps35k.png",
      "image50px": "https://static0.fitbit.com/images/badges_new/badge_daily_steps35k.png",
      "image75px": "https://static0.fitbit.com/images/badges_new/75px/badge_daily_steps35k.png",
      "marketingDescription": "You've walked 35,000 steps  And earned the Hiking Boot badge!",
      "mobileDescription": "Woot, woot! There's no mountain you can't climb and no goal you can't get.",
      "name": "Hiking Boot (35,000 steps in a day)",
      "shareImage640px": "https://static0.fitbit.com/images/badges_new/386px/shareLocalized/en_US/badge_daily_steps35k.png",
      "shareText": "I took 35,000 steps and earned the Hiking Boot badge! #Fitbit",
      "shortDescription": "35,000 steps",
      "shortName": "Hiking Boot",
      "timesAchieved": 1,
      "value": 35000
    }
  ]
}

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

The 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.

Privacy Settings

There are two privacy settings to consider for the response data:

The My Achievements (Friends or Anyone) privacy permission grants access to other user's resource.
The My Body (Friends or Anyone) privacy permission reveals weight badge data in response.

Get Profile