Get IRN Profile
This endpoint returns the user state for Irregular Rhythm Notifications (IRN). The user state contains most information about the user’s current engagement with the feature, including onboarding progress and algorithm processing state.
Note: The IRN API is for research use or investigational use only, and is not intended for clinical or diagnostic purposes.
Scope: irregular_rhythm_notifications
Request
| GET | /1/user/[user-id]/irn/profile.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 |
| 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
GET https://api.fitbit.com/1/user/GGNJL9/irn/profile.json
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"
Response
| Element Name | Description |
| onboarded | Whether or not the user has onboarded onto the IRN feature. |
| enrolled | Whether or not the user is currently enrolled in having their data processed for IRN alerts. |
| lastUpdated | The timestamp of the last piece of analyzable data synced by the user (displayed as local time) |
{
"onboarded": true,
"enrolled": true,
"lastUpdated": "2022-09-28T17:12:30.000"
}
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 compatibility
The IRN data is retrieved from the user’s Fitbit account. This gives the user secure and transparent control over their data. The data is then processed and made available through the API after the user syncs their device with the Fitbit data service.
Most of the current devices sold support IRN data collection. See the Fitbit Product page to determine if your specific device supports IRN.
Rate limit
The IRN endpoints are bound by our standard rate limit. See Rate Limits.
Subscription Support for IRN
IRN does not support subscription notifications (webhooks). We recommend querying IRN data once or twice a day to determine if new data is available (e.g. 12 noon and midnight). However, the frequency or rate at which you query IRN data should be based on your specific use cases and with this in mind.
