Get Subscription List
chevron down
 

Get Subscription List

Retrieves a list of subscriptions created by your application for a specific user. You can either fetch subscriptions for a specific collection or the entire list of subscriptions for the user. For best practice, make sure that your application maintains this list on your side and uses this endpoint only to periodically ensure data consistency. See Getting a List of Subscriptions for more information.

Scope: See collection-path URI Argument


Request

GET /1/user/[user-id]/[collection-path]/apiSubscriptions.json

URI Arguments
user-id required The encoded ID of the user. Use "-" (dash) for current logged-in user.
collection-path optional Collection of data to retrieve notifications. If not provided, a subscription will be deleted for all collections.

Supported: activities | body | foods | sleep | userRevokedAccess

The user must consent to the proper OAuth 2.0 scope before a subscription can be created for the collection. The list of requirements are:

  • activities collection requires activity scope.
  • body collection requires weight scope.
  • foods collection requires nutrition scope.
  • sleep collection requires sleep scope.
  • userRevokedAccess collection does not require any scopes.
  • If no collection specified, activity, nutrition, profile, settings, sleep, weight scopes are required.

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.
X-Fitbit-Subscriber-Id optional The ID of the subscriber to receive notifications, as defined on dev.fitbit.com. If not present, the default subscriber is used.

Examples

Response

Element Name Description
collectionType
ownerId
ownerType
subscriberId
subscriptionId
{
"collectionType":"activities",
"ownerId":"GGNJL9",
"ownerType":"user",
"subscriberId":"1",
"subscriptionId":"320"
}
      

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 Returned if the given user is already subscribed to to the stream.
405 Returned if a GET is attempted on an endpoint where only POST can be used.

Note: For a complete list of response codes, please refer to the Troubleshooting Guide.