Get Friends Leaderboard

This endpoint returns the user's friend leaderboard in the format requested using units in the unit system which corresponds to the Accept-Language header provided. This scope does not provide access to the friend's Fitbit data. Those users will need to individually consent to share their data with your application.

Scope: social

Request

GET	/1.1/user/-/leaderboard/friends.json

Request Headers

authorization	required	Specify the token type and Fitbit user’s access token. Token type: `Bearer`
accept	optional	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.1/user/-/leaderboard/friends.json
GET https://api.fitbit.com/1.1/user/GGNJL9/leaderboard/friends.json

curl -X GET "https://api.fitbit.com/1.1/user/[user-id]/leaderboard/friends.json" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"

Element Name	Description
type	Describes the user based on the frequency they sync their steps. Supported: `ranked-user` \| `inactive-user`
id	Fitbit user id.
attributes : step-rank	Ranking among the user's friends.
attributes : step-summary	Weekly step count.
attributes : avatar	Link to user's avatar picture.
attributes : child	Boolean value describing friend as a child account.
attributes : friend	Supported: `true`
attributes : name	Person's display name.
relationships : user : data : id	Fitbit user id.
relationships : user : data : type	Supported: `person`

{
 "data": [
   {
     "type": "ranked-user",
     "id": "<friend_1>",
     "attributes": {
       "step-rank": 1,
       "step-summary": 6392.0
     },
     "relationships": {
       "user": {
         "data": {
           "type": "person",
           "id": "<friend_1>"
         }
       }
     }
   },
   {
     "type": "ranked-user",
     "id": "<friend_2>",
     "attributes": {
       "step-rank": 2,
       "step-summary": 5205.0
     },
     "relationships": {
       "user": {
         "data": {
           "type": "person",
           "id": "<friend_2>"
         }
       }
     }
   },
   {
     "type": "inactive-user",
     "id": "<friend_3>",
     "relationships": {
       "user": {
         "data": {
           "type": "person",
           "id": "<friend_3>"
         }
       }
     }
   }
 ],
 "included": [
   {
     "type": "person",
     "id": "<friend_1>",
     "attributes": {
       "avatar": "https://static0.fitbit.com/images/profile/defaultProfile_150.png",
       "child": false,
       "friend": true,
       "name": "Mary"
     }
   },
   {
     "type": "person",
     "id": "<friend_2>",
     "attributes": {
       "avatar": "https://static0.fitbit.com/images/profile/defaultProfile_150.png",
       "child": false,
       "friend": true,
       "name": "James"
     }
   },
   {
     "type": "person",
     "id": "<friend_3>",
     "attributes": {
       "avatar": "https://static0.fitbit.com/images/profile/defaultProfile_150.png",
       "child": false,
       "friend": true,
       "name": "Erin"
     }
   }
 ]
}

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

Authorized user (self) is also included in the response. Leaderboard has the last seven (7) days worth of data (the previous six days plus today's date) in real time.

The Average Daily Step Count privacy setting in the Fitbit user's profile settings allows a user to be included to Friends leaderboard whether they hide themselves on their profile settings or not.

Inviting friends

Fitbit does not offer endpoints that can send or respond to friend invitation requests. The Fitbit user must send friend requests through the mobile application or Fitbit.com. See How do I connect with friends on Fitbit?

Get Friends