Get Alarms

Retrieves the alarms enabled for a specific device. This endpoint is supported for trackers that support alarms.

Scope: settings

Request

GET	/1/user/[user-id]/devices/tracker/[tracker-id]/alarms.json

URI Arguments

user-id	required	The encoded ID of the user. Use "-" (dash) for current logged-in user.
tracker-id	required	The ID of the tracker for which the data is returned. The tracker-id can be found by using the Get Devices endpoint.

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/tracker/755971234/alarms.json
GET https://api.fitbit.com/1/user/GGNJL9/devices/tracker/755971234/alarms.json

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

Element Name	Description
trackerAlarms : alarmId	Numerical value representing the alarm ID.
trackerAlarms : deleted	Indicates if an alarm has been deleted. Supported: `true` \| `false`
trackerAlarms : enabled	Indicates if an alarm is enabled. Supported: `true` \| `false`
trackerAlarms : recurring	Indicates if an alarm is recurring. Supported: `true` \| `false`
trackerAlarms : snoozeCount	Indicates the number of times the alarm will snooze.
trackerAlarms : snoozeLength	Indicates the time in minutes between snooze periods.
trackerAlarms : syncedToDevice	Supported: `true` \| `false`
trackerAlarms : time	The time and UTC offset for the specified alarm.
trackerAlarms : vibe	Returns the type of vibration configured. Supported: `DEFAULT`
trackerAlarms : weekDays	Returns the recurring days of the week which the alarm is set. Supported: `MONDAY` \| `TUESDAY` \| `WEDNESDAY` \| `THURSDAY` \| `FRIDAY` \| `SATURDAY` \| `SUNDAY`

{
    "trackerAlarms": [
        {
            "alarmId": 11426382,
            "deleted": false,
            "enabled": true,
            "recurring": true,
            "snoozeCount": 3,
            "snoozeLength": 9,
            "syncedToDevice": false,
            "time": "07:15-08:00",
            "vibe": "DEFAULT",
            "weekDays": [
                "MONDAY",
                "TUESDAY"
            ]
        }
    ]
}

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

Device support

The Fitbit devices have the ability to set an alarm. Older devices whose alarms are configured in the mobile application support the create, delete, get and update alarm endpoints. Newer devices, listed in this help article https://help.fitbit.com/articles/en_US/Help_article/1868.htm, contain an on-device alarm application, and do not support the alarm endpoints. The alarms for these devices can only be set on the device itself.

Setting an alarm without a recurring schedule is intended for next day purposes only.

Delete Alarm

Get Devices