Working with the API
Athletes
Movements
List athlete results
curl --request GET \
--url https://api.wodup.dev/api/public/athletes/{id}/results \
--header 'Authorization: Basic <encoded-value>'[
{
"competition": null,
"id": "s_123abc",
"results": [
{
"comments": [
{
"author": {
"name": "Jane Doe"
},
"created_at": "2000-01-01T00:00:00Z",
"id": "c_123abc",
"replies": [],
"text": "Great job!"
}
],
"description": null,
"details": {
"rest": {
"type": "as_needed"
},
"sets": [
{
"load": 6,
"load_unit": "kg",
"movement_id": "mv_fT0m3viH",
"reps": 5
}
]
},
"done_at": "2001-01-01T12:00:00.000000Z",
"movements": [
{
"complex_details": null,
"description": null,
"has_calories": false,
"has_distance": false,
"has_duration": false,
"has_height": false,
"has_load": true,
"has_power": false,
"has_reps": true,
"id": "mv_fT0m3viH",
"name": "Back Squat",
"source": "wodup",
"video": {
"id": "dQw4w9WgXcQ",
"service": "youtube"
}
}
],
"notes": null,
"perceived_exertion": 0,
"prescribed_workout": {
"description": "Back Squat 5 reps",
"details": {
"movements": [
{
"id": "mv_fT0m3viH",
"load": null,
"reps": "5"
}
],
"rest": {
"type": "as_needed"
},
"type": "Strength"
},
"movements": [
{
"complex_details": null,
"description": null,
"has_calories": false,
"has_distance": false,
"has_duration": false,
"has_height": false,
"has_load": true,
"has_power": false,
"has_reps": true,
"id": "mv_fT0m3viH",
"name": "Back Squat",
"source": "wodup",
"video": {
"id": "dQw4w9WgXcQ",
"service": "youtube"
}
}
],
"name": null,
"type": "Strength"
},
"scaled_workout": null,
"scaling": "rx",
"status": "completed",
"type": "StrengthResult",
"wod_component_id": null
}
],
"wod": {
"id": "wod_123abc",
"name": "Morning Workout",
"occurs_on": "2020-01-01",
"order": 0,
"program": {
"access": "private",
"id": "p_123abc",
"name": "Strength and Conditioning",
"period": "continuous",
"status": "active"
},
"publish_at": "2020-01-01T00:00:00Z"
}
}
]Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Headers
Only used by platform integrations
ID of gym to execute on behalf of
Path Parameters
ID of athlete to get results for
Query Parameters
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1 <= x <= 100A cursor for use in pagination. after_cursor is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after_cursor=obj_foo in order to fetch the next page of the list.
A cursor for use in pagination. before_cursor is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include before_cursor=obj_bar in order to fetch the previous page of the list.
Response
Workout Session ID
Results in this workout session
Result object
Comments on this result
Date comment created. ISO8601 timestamp in UTC
Comment ID
Can be null if comment has been deleted
Author name
{ "name": "Jane Doe" }
Comment text
A short description of the result
TBD
When the result was done.
Movement objects referenced by this result
Movement object
Movement instructions / description
Does this movement involve calories. E.g. Row
Does this movement involve distance. E.g. Row
Does this movement involve duration. E.g. Row or Weighted Plank Hold
Does this movement involve height. E.g. Box Jumps
Does this movement involve load. E.g. Back Squat or Weighted Plank Hold
Does this movement involve power. E.g. Row
Does this movement involve reps. E.g. Push-Up or Back Squat
Movement ID
Movement name
Whether this movement is from the global WodUp library or a custom movement
wodup, custom From 1-5. 0 means no entry.
Workout object
A human readable description of the workout
Movement objects referenced by this workout
Movement object
Movement instructions / description
Does this movement involve calories. E.g. Row
Does this movement involve distance. E.g. Row
Does this movement involve duration. E.g. Row or Weighted Plank Hold
Does this movement involve height. E.g. Box Jumps
Does this movement involve load. E.g. Back Squat or Weighted Plank Hold
Does this movement involve power. E.g. Row
Does this movement involve reps. E.g. Push-Up or Back Squat
Movement ID
Movement name
Whether this movement is from the global WodUp library or a custom movement
wodup, custom Workout type
Amrap, Cardio, CardioIntervals, DeathBy, Emom, Fgb, ForTime, FranStyle, Generic, MaxReps, RoundsForTime, Strength, Tabata, TwelveDays, WarmUp An official name for the workout
{
"description": "Back Squat 5 reps",
"details": {
"movements": [
{
"id": "mv_fT0m3viH",
"load": null,
"reps": "5"
}
],
"rest": { "type": "as_needed" },
"type": "Strength"
},
"movements": [
{
"complex_details": null,
"description": null,
"has_calories": false,
"has_distance": false,
"has_duration": false,
"has_height": false,
"has_load": true,
"has_power": false,
"has_reps": true,
"id": "mv_fT0m3viH",
"name": "Back Squat",
"source": "wodup",
"video": { "id": "dQw4w9WgXcQ", "service": "youtube" }
}
],
"name": null,
"type": "Strength"
}
Whether the workout was scaled
rx, rxplus, scaled, modified Has the result been completed
completed, cap, dnf, dns Result type
AmrapResult, CardioResult, CardioIntervalsResult, DeathByResult, EmomResult, FgbResult, ForTimeResult, FranStyleResult, GenericResult, MaxRepsResult, RoundsForTimeResult, StrengthResult, TabataResult, TwelveDaysResult, WarmUpResult Athlete notes
Workout object
A human readable description of the workout
Movement objects referenced by this workout
Movement object
Movement instructions / description
Does this movement involve calories. E.g. Row
Does this movement involve distance. E.g. Row
Does this movement involve duration. E.g. Row or Weighted Plank Hold
Does this movement involve height. E.g. Box Jumps
Does this movement involve load. E.g. Back Squat or Weighted Plank Hold
Does this movement involve power. E.g. Row
Does this movement involve reps. E.g. Push-Up or Back Squat
Movement ID
Movement name
Whether this movement is from the global WodUp library or a custom movement
wodup, custom Workout type
Amrap, Cardio, CardioIntervals, DeathBy, Emom, Fgb, ForTime, FranStyle, Generic, MaxReps, RoundsForTime, Strength, Tabata, TwelveDays, WarmUp An official name for the workout
{
"description": "Back Squat 5 reps",
"details": {
"movements": [
{
"id": "mv_fT0m3viH",
"load": null,
"reps": "5"
}
],
"rest": { "type": "as_needed" },
"type": "Strength"
},
"movements": [
{
"complex_details": null,
"description": null,
"has_calories": false,
"has_distance": false,
"has_duration": false,
"has_height": false,
"has_load": true,
"has_power": false,
"has_reps": true,
"id": "mv_fT0m3viH",
"name": "Back Squat",
"source": "wodup",
"video": { "id": "dQw4w9WgXcQ", "service": "youtube" }
}
],
"name": null,
"type": "Strength"
}
WOD Component ID if this result belongs to a WOD
Competition for this workout session
WOD for this workout session
curl --request GET \
--url https://api.wodup.dev/api/public/athletes/{id}/results \
--header 'Authorization: Basic <encoded-value>'[
{
"competition": null,
"id": "s_123abc",
"results": [
{
"comments": [
{
"author": {
"name": "Jane Doe"
},
"created_at": "2000-01-01T00:00:00Z",
"id": "c_123abc",
"replies": [],
"text": "Great job!"
}
],
"description": null,
"details": {
"rest": {
"type": "as_needed"
},
"sets": [
{
"load": 6,
"load_unit": "kg",
"movement_id": "mv_fT0m3viH",
"reps": 5
}
]
},
"done_at": "2001-01-01T12:00:00.000000Z",
"movements": [
{
"complex_details": null,
"description": null,
"has_calories": false,
"has_distance": false,
"has_duration": false,
"has_height": false,
"has_load": true,
"has_power": false,
"has_reps": true,
"id": "mv_fT0m3viH",
"name": "Back Squat",
"source": "wodup",
"video": {
"id": "dQw4w9WgXcQ",
"service": "youtube"
}
}
],
"notes": null,
"perceived_exertion": 0,
"prescribed_workout": {
"description": "Back Squat 5 reps",
"details": {
"movements": [
{
"id": "mv_fT0m3viH",
"load": null,
"reps": "5"
}
],
"rest": {
"type": "as_needed"
},
"type": "Strength"
},
"movements": [
{
"complex_details": null,
"description": null,
"has_calories": false,
"has_distance": false,
"has_duration": false,
"has_height": false,
"has_load": true,
"has_power": false,
"has_reps": true,
"id": "mv_fT0m3viH",
"name": "Back Squat",
"source": "wodup",
"video": {
"id": "dQw4w9WgXcQ",
"service": "youtube"
}
}
],
"name": null,
"type": "Strength"
},
"scaled_workout": null,
"scaling": "rx",
"status": "completed",
"type": "StrengthResult",
"wod_component_id": null
}
],
"wod": {
"id": "wod_123abc",
"name": "Morning Workout",
"occurs_on": "2020-01-01",
"order": 0,
"program": {
"access": "private",
"id": "p_123abc",
"name": "Strength and Conditioning",
"period": "continuous",
"status": "active"
},
"publish_at": "2020-01-01T00:00:00Z"
}
}
]