Important Update: Changes to Fitbit Get Sleep Goals API

[IncaFitbit]

Hi Fitbit Web API Developer,

We’re reaching out to inform you of upcoming updates to the GET Sleep Goals API that may impact your application. On or shortly after June 23, 2025, the consistency object will be removed as part of the response, which might result in an error communicating Sleep Goal related data with your application. If you currently use the GET Sleep Goals API and are calling for the consistency data type, you will need to update your response. The current and new responses are shown below for your reference.

We recommend updating your application before June 23, 2025 to account for this change and ensure reliable communication with your app. 

If you have questions, please contact us through Issue Tracker. We look forward to supporting you through this update.

Thank you for being a valued Fitbit Web API developer. 

The Fitbit Web API team

Current Response

{
  "consistency": {   
    "typicalDuration": 503,
    "recommendedSleepGoal": 525,
    "typicalWakeupTime": "07:50",
    "flowId": 0,
    "awakeRestlessPercentage": 0.043629851462804216  },   
  "goal": {   
    "minDuration": 600,  
    "updatedOn": "2025-04-14T13:12:16.615Z",  
    "bedtime": "22:00",  
    "wakeupTime": "07:00"  
  }
}

New Response

{
  "goal": {   
    "minDuration": 600,  
    "updatedOn": "2025-04-14T13:12:16.615Z",  
    "bedtime": "22:00",  
    "wakeupTime": "07:00"  
  }
}