Key

This line was added.

This line was removed.

Formatting was changed.

Comment:
Added maintenance mode error

Table of Contents

maxLevel

2

SUCCESS

Info

title

Versioning

We will maintain collections of existing fields as well as their format through the complete lifecycle of version 1 of the API. However, the API is still in BETA and from time to time we may need to extend existing endpoints by introduction of new fields to keep them up to date with improvements to Fitbit platform. We definitely will announce such changes on this wiki and in Fitbit API Dev Forum before they go into production release. Still, keep in mind that best practice for your application's response parser would be to stay loose and don't fail validation if it sees extra fields.

...

Status code:

204 No Content (DELETE requests), 201 Created (POST requests)

Content-Type:

text/xml or application/json

Body:

Empty body

Response - with Data

When the response returns data in addition to a status code, the body contains the data.

Status code:

200 OK (GET/POST requests), 201 Created (POST requests)

Content-Type:

text/xml or application/json

Body:

Response in the format requested: JSON or XML

Response Body Format

JSON:

Code Block

{
<data>
}

XML:

Code Block

<?xml version="1.0" encoding="UTF-8"?>
<result>
[data]
</result>

...

Status code:

400 Bad Request, 401 Unauthorized, 404 Not Found, 409 Conflict

Content-Type:

application/x-www-form-urlencoded

Body:

Error response body in the format requested: JSON or XML

Errors:

400 Bad Request

Any case where either endpoint doesn't exist, resource path parameters are invalid, POST request parameters are invalid or no Authentication header provided. This doesn't include invalid specific resource ids