Get Devices

Retrieves a list of Fitbit devices paired to a user's account.

Scope: settings

Request

GET	/1/user/[user-id]/devices.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/-/devices.json
GET https://api.fitbit.com/1/user/GGNJL9/devices.json

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

Element Name	Description
battery	Returns the battery level of the device. Supported: `High` \| `Medium` \| `Low` \| `Empty`
batteryLevel	Returns the battery level percentage of the device.
deviceVersion	The product name of the device.
features	Lists any unique features supported by the device.
id	The device ID.
lastSyncTime	Timestamp representing the last time the device was sync'd with the Fitbit mobile application.
mac	Mac ID number
type	Supported : `TRACKER` \| `SCALE`

[
  {
    "battery": "Medium",
    "batteryLevel": 60,
    "deviceVersion": "Charge 2",
    "features": [],
    "id": "816713257",
    "lastSyncTime": "2019-11-07T12:00:58.000",
    "mac": "16ADD56D54GD",
    "type": "TRACKER"
  }
]

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

Knowing when a Fitbit device last synced with the Fitbit server is useful when diagnosing reports that the Fitbit app is showing different values from what the Fitbit Web API returns. Fitbit's own apps use the same Web API available to third-party developers. However, when an active Bluetooth connection is available, Fitbit's apps will show the summary values displayed on the device. Often, this data has not yet synced with Fitbit's servers.

Third-party applications can check when a Fitbit device last synced with Fitbit's servers using this endpoint.

For information on supporting users who have multiple devices paired with their account, see Multi-Device Overview.

Get Alarms

Update Alarm