Get user's profile in the format requested using units in the unit system which corresponds to the Accept-Language header provided.

Access Type: Read

Rate Limited: Yes

OAuth: oauth_token is optional, if omitted you should explicitly specify <user-id>.

Privacy: Basic profile is always public, About Me (Friends or Anyone), Age and height (Friends or Anyone), Location (Friends or Anyone), My Body (Friends or Anyone) privacy permissions grant granular access to other user's respective profile fields, considering:

Resource URL

GET /<api-version>/user/<user-id>/profile.<response-format>

api-version

The API version. Currently 1.

user-id

User's encoded id or "-" (dash) to indicate user currently authenticated via the token credentials provided.

response-format

The response format. Currently supported response formats are json and xml for responses in JSON and XML, respectively.

GET /1/user/228TQ4/profile.json
GET /1/user/228TQ4/profile.xml
GET /1/user/-/profile.json
GET /1/user/-/profile.xml

Authentication

Via token credentials. oauth_token authentication header parameter is optional.

Request Headers

Accept-Language

optional

The measurement unit system to use for response values.

Response

API Response in format requested: JSON or XML.

Response body format

Note: Text within <> is a descriptive place holder for a value or repeated elements.

{
    "user":{
        "aboutMe":<value>,
        "avatar":<value>,
        "avatar150":<value>,
        "city":<value>,
        "country":<value>,
        "dateOfBirth":"<value>,
        "displayName":<value>,
        "distanceUnit":<value>,
        "encodedId":<value>,
        "foodsLocale":<value>
        "fullName":<value>,
        "gender":<FEMALE|MALE|NA>,
        "glucoseUnit":<value>,
        "height":<value>,
        "heightUnit":<value>,
        "locale":<value>,
        "memberSince":<value>,
        "nickname":<value>,
        "offsetFromUTCMillis":<value>,
        "state":<value>,
        "strideLengthRunning":<value>,
        "strideLengthWalking":<value>,
        "timezone":<value>,
        "waterUnit":<value>,
        "weight":<value>,
        "weightUnit":<value>
    }
}

Note: Text within [] is a descriptive place holder for a value or repeated elements.

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <user>
        <aboutMe>[value]</aboutMe>
        <avatar>[value]</avatar>
        <avatar150>[value]</avatar150>
        <city>[value]</city>
        <country>[value]</country>
        <dateOfBirth>[value]</dateOfBirth>
        <displayName>[value]</displayName>
        <distanceUnit>[value]</distanceUnit>
        <encodedId>[value]</encodedId>
        <foodsLocale>[value]</foodsLocale>
        <fullName>[value]</fullName>
        <gender>[FEMALE|MALE|NA]</gender>
        <glucoseUnit>[value]</glucoseUnit>
        <height>[value]</height>
        <heightUnit>[value]</heightUnit>
        <locale>[value]</locale>
        <memberSince>[value]</memberSince>
        <nickname>[value]</nickname>
        <offsetFromUTCMillis>[value]</offsetFromUTCMillis>
        <state>[value]</state>
        <strideLengthRunning>[value]</strideLengthRunning>
        <strideLengthWalking>[value]</strideLengthWalking>
        <timezone>[value]</timezone>
        <waterUnit>[value]</waterUnit>
        <weight>[value]</weight>
        <weightUnit>[value]</weightUnit>
    </user>
</result>

1. Note that <displayName> field present at all times. It contains one of the following – <nickname>, first name with the leading letter of last name or part of user's email address before "@" (in case nickname and fullName empty).
2. Units (<glucoseUnit> etc.) represent default unit settings of the user in the his/her web UI. Note, that <heightUnit> also used as a default for all other body measurements (i.e. neck, bicep etc.).
3. <locale> reveals the local website version that user is currently using (en_US, en_GB...) 

 

Examples

{
    "user":{
        "aboutMe":"I live in San Francisco.",
        "avatar":"http://www.fitbit.com/images/profile/defaultProfile_100_male.gif",
        "avatar150":"http://www.fitbit.com/images/profile/defaultProfile_150_male.gif",
        "city":"San Francisco",
        "country":"US",
        "dateOfBirth":"1970-02-18",
        "displayName":"Fitbit U.",
        "distanceUnit":"METRIC",
        "encodedId":"257V3V",
        "fullName":"Fitbit User",
        "gender":"MALE",
        "glucoseUnit":"METRIC",
        "height":176.75,
        "heightUnit":"METRIC",
        "nickname":"",
        "locale":"en_GB",
        "memberSince":"2010-02-07",
        "offsetFromUTCMillis":-25200000,
        "state":"CA",
        "strideLengthRunning":0,
        "strideLengthWalking":0,
        "timezone":"America/Los_Angeles",
        "waterUnit":"METRIC",
        "weight":80.55
        "weightUnit":"METRIC"
    }
}
<?xml version="1.0" encoding="UTF-8"?>
<result>
    <user>
        <aboutMe>I live in San Francisco.</aboutMe>
        <avatar>http://www.fitbit.com/images/profile/defaultProfile_100_male.gif</avatar>
        <avatar150>http://www.fitbit.com/images/profile/defaultProfile_150_male.gif</avatar150>
        <city>San Francisco</city>
        <country>US</country>
        <dateOfBirth>1971-02-18</dateOfBirth>
        <displayName>Nick</displayName>
        <distanceUnit>en_US</distanceUnit> 
        <encodedId>2295YW</encodedId>
        <fullName>Fitbit User</fullName>
        <gender>MALE</gender>
        <glucoseUnit>METRIC</glucoseUnit>
        <height>176.75</height>
        <heightUnit>en_US</heightUnit> 
        <locale>en_GB</locale>
        <memberSince>2010-02-07</memberSince>
        <nickname>Nick</nickname>
        <offsetFromUTCMillis>-25200000</offsetFromUTCMillis>
        <state>CA</state>
        <strideLengthRunning>0</strideLengthRunning>
        <strideLengthWalking>0</strideLengthWalking>
        <timezone>America/Los_Angeles</timezone>
        <volumeUnit>METRIC</volumeUnit> 
        <weight>80.55</weight>
        <weightUnit>METRIC</weightUnit>
    </user>
</result>