API Endpoints
Use these endpoints when you want to access a User's data based on a request by the User.
The endpoints in this documentation are always relative to https://Jawbone.com if not included as prefix.
The current API version is v.1.0. If the API version is not specified then the API call defaults to the latest version. It is recommended to explicitly use API versions. This will prevent compatibility issues due to changes that can be introduced in newer API versions.
Band Events
- Retrieve hardware events from UP24 band
-
GET https://jawbone.com/nudge/api/v.1.0/users/@me/bandevents
Body
- Retrieve user records of body metrics
-
GET https://jawbone.com/nudge/api/v.1.0/users/@me/body_events
- Get a single body composition record event
-
GET https://jawbone.com/nudge/api/v.1.0/body_events/{xid} - Record body metrics
-
POST https://jawbone.com/nudge/api/v.1.0/users/@me/body_events
- Delete body composition record event
DELETE https://jawbone.com/nudge/api/v.1.0/body_events/{xid}
Cardiac
- Retrieve user cardiac metrics
-
GET https://jawbone.com/nudge/api/v.1.0/users/@me/cardiac_events
- Get a single cardiac metric record event
-
GET https://jawbone.com/nudge/api/v.1.0/cardiac_events/{xid} - Record heart rate and blood pressure
-
POST https://jawbone.com/nudge/api/v.1.0/users/@me/cardiac_events
- Delete cardiac metric record event
-
DELETE https://jawbone.com/nudge/api/v.1.0/cardiac_events/{xid}
Generic Events
- Retrieve user generic events
-
GET https://jawbone.com/nudge/api/v.1.0/users/@me/generic_events
- Create a new event that will show in the user's feed
-
POST https://jawbone.com/nudge/api/v.1.0/users/@me/generic_events
- Update a generic event
-
POST https://jawbone.com/nudge/api/v.1.0/generic_events/{xid}/partialUpdate - Delete generic event record
-
DELETE https://jawbone.com/nudge/api/v.1.0/generic_events/{xid}
Goals
- Retrieve user goals
-
GET https://jawbone.com/nudge/api/v.1.0/users/@me/goals
Meals
- Get the user's meal list
-
GET https://jawbone.com/nudge/api/v.1.0/users/@me/meals
- Get details on a specific meal
-
GET https://jawbone.com/nudge/api/v.1.0/meals/{xid} - Create a new meal
-
POST https://jawbone.com/nudge/api/v.1.0/users/@me/meals
- Update a meal event
-
POST https://jawbone.com/nudge/api/v.1.0/meals/{xid}/partialUpdate - Delete a meal event
-
DELETE https://jawbone.com/nudge/api/v.1.0/meals/{xid}
Mood
- Get the user's moods
-
GET https://jawbone.com/nudge/api/v.1.0/users/@me/mood
- Get details on a specific mood
-
GET https://jawbone.com/nudge/api/v.1.0/mood/{xid} - Record the user's mood
-
POST https://jawbone.com/nudge/api/v.1.0/users/@me/mood
- Delete mood event
-
DELETE https://jawbone.com/nudge/api/v.1.0/mood/{xid}
Moves
- Get the user's move list
-
GET https://jawbone.com/nudge/api/v.1.0/users/@me/moves
- Get details on a specific move
-
GET https://jawbone.com/nudge/api/v.1.0/moves/{xid} - Get the user's move graphs
-
GET https://jawbone.com/nudge/api/v.1.0/moves/{xid}/image - Get move intensity
-
GET https://jawbone.com/nudge/api/v.1.0/moves/{xid}/snapshot
Sleeps
- Get the user's sleep list
-
GET https://jawbone.com/nudge/api/v.1.0/users/@me/sleeps
- Get the details on a specific sleep
-
GET https://jawbone.com/nudge/api/v.1.0/sleeps/{xid} - Get the user's sleep graphs
-
GET https://jawbone.com/nudge/api/v.1.0/sleeps/{xid}/image - Get sleep phases
-
GET https://jawbone.com/nudge/api/v.1.0/sleeps/{xid}/snapshot - Record the user's sleep
-
POST https://jawbone.com/nudge/api/v.1.0/users/@me/sleeps
- Delete a sleep
-
DELETE https://jawbone.com/nudge/api/v.1.0/sleeps/{xid}
Time Zone
- Get the time zone
-
GET https://jawbone.com/nudge/api/v.1.0/users/@me/timezone
Trends
- Get the user trends
-
GET https://jawbone.com/nudge/api/v.1.0/users/@me/trends
User information
- Get detailed information about the user
-
GET https://jawbone.com/nudge/api/v.1.0/users/@me
- Get list of friends
-
GET https://jawbone.com/nudge/api/v.1.0/users/@me/friends
Workouts
- Get the user's workout list
-
GET https://jawbone.com/nudge/api/v.1.0/users/@me/workouts
- Get the details on a specific workout
-
GET https://jawbone.com/nudge/api/v.1.0/workouts/{xid} - Get the user's workout graphs
-
GET https://jawbone.com/nudge/api/v.1.0/workouts/{xid}/image - Get workout intensity
-
GET https://jawbone.com/nudge/api/v.1.0/workouts/{xid}/snapshot - Create a new workout
-
POST https://jawbone.com/nudge/api/v.1.0/users/@me/workouts
- Update a workout
-
POST https://jawbone.com/nudge/api/v.1.0/workouts/{xid}/partialUpdate - Delete a workout
-
DELETE https://jawbone.com/nudge/api/v.1.0/workouts/{xid}