Skip to main content
GET
/
api
/
public
/
results
/
{id}
Get a result
curl --request GET \
  --url https://api.wodup.dev/api/public/results/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "comments": [
    {
      "author": {
        "id": "ath_123abc",
        "name": "Jane Doe"
      },
      "can_modify": true,
      "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",
  "id": "r_123abc",
  "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
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
wodup-gym
string

Only used by platform integrations
ID of gym to execute on behalf of

Path Parameters

​
id
string
required

ID of result to get

Response

200 - application/json

Result object

​
comments
Comment · object[]
required

Comments on this result

​
description
string
required

A short description of the result

​
details
string<json>
required

TBD

​
done_at
string<timestampz>
required

When the result was done.

​
id
string
required

Result ID

​
movements
Movement · object[]
required

Movement objects referenced by this result

​
perceived_exertion
string
required

From 1-5. 0 means no entry.

​
prescribed_workout
object
required

Workout object

Example:
{
  "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"
}
​
scaling
enum<string>
required

Whether the workout was scaled

Available options:
rx,
rxplus,
scaled,
modified
​
status
enum<string>
required

Has the result been completed

Available options:
completed,
cap,
dnf,
dns
​
type
enum<string>
required

Result type

Available options:
AmrapResult,
CardioResult,
CardioIntervalsResult,
DeathByResult,
EmomResult,
FgbResult,
ForTimeResult,
FranStyleResult,
GenericResult,
MaxRepsResult,
RoundsForTimeResult,
StrengthResult,
TabataResult,
TwelveDaysResult,
WarmUpResult
​
notes
string

Athlete notes

​
scaled_workout
object

Workout object

Example:
{
  "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
string

WOD Component ID if this result belongs to a WOD