API Endpoints
Use these endpoints when you want to access a User's data based on a request by the User.
The endpoints in the documentation are always relative to https://jawbone.com if not included as prefix.
Band Events
- Retrieve hardware events from UP24 band
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me/bandevents
Body
- Retrieve user records of body metrics
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me/body_events
- Get a single body composition record event
-
GET https://jawbone.com/nudge/api/v.1.1/body_events/{xid} - Record body metrics
-
POST https://jawbone.com/nudge/api/v.1.1/users/@me/body_events
- Delete body composition record event
DELETE https://jawbone.com/nudge/api/v.1.1/body_events/{xid}
Heart Rate
- Retrieve resting heart rate
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me/heartrates
Custom Events
- Retrieve user custom events
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me/generic_events
- Create a new event that will show in the user's feed
-
POST https://jawbone.com/nudge/api/v.1.1/users/@me/generic_events
- Update a custom event
-
POST https://jawbone.com/nudge/api/v.1.1/generic_events/{xid}/partialUpdate - Delete custom event record
-
DELETE https://jawbone.com/nudge/api/v.1.1/generic_events/{xid}
Goals
- Retrieve user goals
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me/goals
- Create or update a user goal
-
POST https://jawbone.com/nudge/api/v.1.1/users/@me/goals
Meals
- Get the user's meal list
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me/meals
- Get details on a specific meal
-
GET https://jawbone.com/nudge/api/v.1.1/meals/{xid} - Create a new meal
-
POST https://jawbone.com/nudge/api/v.1.1/users/@me/meals
- Update a meal event
-
POST https://jawbone.com/nudge/api/v.1.1/meals/{xid}/partialUpdate - Delete a meal event
-
DELETE https://jawbone.com/nudge/api/v.1.1/meals/{xid}
Mood
- Get the user's moods
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me/mood
- Get details on a specific mood
-
GET https://jawbone.com/nudge/api/v.1.1/mood/{xid} - Record the user's mood
-
POST https://jawbone.com/nudge/api/v.1.1/users/@me/mood
- Delete mood event
-
DELETE https://jawbone.com/nudge/api/v.1.1/mood/{xid}
Moves
- Get the user's move list
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me/moves
- Get details on a specific move
-
GET https://jawbone.com/nudge/api/v.1.1/moves/{xid} - Get the user's move graphs
-
GET https://jawbone.com/nudge/api/v.1.1/moves/{xid}/image - Get move ticks
-
GET https://jawbone.com/nudge/api/v.1.1/moves/{xid}/ticks
Refresh Token
- Retrieve user refresh token
-
POST https://jawbone.com/nudge/api/v.1.1/users/@me/refreshToken
Settings
- Retrieve user settings
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me/settings
Sleeps
- Get the user's sleep list
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me/sleeps
- Get the details on a specific sleep
-
GET https://jawbone.com/nudge/api/v.1.1/sleeps/{xid} - Get the user's sleep graphs
-
GET https://jawbone.com/nudge/api/v.1.1/sleeps/{xid}/image - Get sleep phases
-
GET https://jawbone.com/nudge/api/v.1.1/sleeps/{xid}/ticks - Record the user's sleep
-
POST https://jawbone.com/nudge/api/v.1.1/users/@me/sleeps
- Delete a sleep
-
DELETE https://jawbone.com/nudge/api/v.1.1/sleeps/{xid}
Time Zone
- Get the time zone
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me/timezone
Trends
- Get the user trends
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me/trends
User information
- Get detailed information about the user
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me
- Get list of friends
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me/friends
Workouts
- Get the user's workout list
-
GET https://jawbone.com/nudge/api/v.1.1/users/@me/workouts
- Get the details on a specific workout
-
GET https://jawbone.com/nudge/api/v.1.1/workouts/{xid} - Get the user's workout graphs
-
GET https://jawbone.com/nudge/api/v.1.1/workouts/{xid}/image - Get workout ticks
-
GET https://jawbone.com/nudge/api/v.1.1/workouts/{xid}/ticks - Create a new workout
-
POST https://jawbone.com/nudge/api/v.1.1/users/@me/workouts
- Update a workout
-
POST https://jawbone.com/nudge/api/v.1.1/workouts/{xid}/partialUpdate - Delete a workout
-
DELETE https://jawbone.com/nudge/api/v.1.1/workouts/{xid}