Get Friends

This endpoint allows the application to retrieves a list of the specified Fitbit user's friends. 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/[user-id]/friends.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	The media type of the response content the client is expecting. Supported: `application/json`

Examples

URL
CURL

GET https://api.fitbit.com/1.1/user/-/friends.json
GET https://api.fitbit.com/1.1/user/GGNJL9/friends.json

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

Element Name	Description
data : type	Supported: `person`
data : id	Fitbit user id.
data : attributes : avatar	Link to user's avatar picture.
data : attributes : child	Boolean value describing friend as a child account.
data : attributes : friend	Boolean value describing user as a friend.
data : attributes : name	Person's display name.

{
 "data": [
   {
     "type": "person",
     "id": "<friend_1>",
     "attributes": {
       "avatar": "https://static0.fitbit.com/images/profile/defaultProfile_150.png",
       "child": false,
       "friend": true,
       "name": "Nick"
     }
   },
  {
     "type": "person",
     "id": "GGNJL9",
     "attributes": {
       "avatar": "https://static0.fitbit.com/images/profile/defaultProfile_150.png",
       "child": false,
       "friend": true,
       "name": "Alan"
     }
   }
 ]
}

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.
403	The user's privacy settings prevent you from seeing their friends.

Note: For a complete list of response codes, please refer to the Troubleshooting Guide.

Additional Information

The Fitbit privacy setting My Friends (Private, Friends Only or Public) determines the access to a user's list of friends.

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 Leaderboard