Get Sleep Goal
chevron down
back search icon cancel search
 
 

Get Sleep Goal

Returns a user's current sleep goal.

Scope: sleep

Request

GET /1.2/user/[user-id]/sleep/goal.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
GET https://api.fitbit.com/1.2/user/-/sleep/goal.json
GET https://api.fitbit.com/1.2/user/GGNJL9/sleep/goal.json
curl -X GET "https://api.fitbit.com/1.2/user/-/sleep/goal.json" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"

Response

Element Name Description
consistency : flowId An integer value representing the sleep goal consistency flow.
  • 0 = A sleep goal is set, but there are not enough sleep logs recorded.
  • 1 = The user either missed their sleep goal or no goal is set, but there are enough sleep logs recorded.
  • 2 = A sleep goal is not set, and there are not enough sleep logs recorded.
  • 3 = The user achieved their sleep goal.
goal : minDuration Length of the sleep goal period in minutes.
goal : updatedOn The timestamp that the goal was created/updated. 
{
  "consistency": {
    "flowId": 2
  },
  "goal": {
    "minDuration": 480,
    "updatedOn": "2020-01-01T13:00:00.126Z"
  }
}

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.
previous
Delete Sleep Log
Get Sleep Log by Date
next