Working with the API
Athletes
Movements
Get a competition
curl --request GET \
--url https://api.wodup.dev/api/public/competitions/{id} \
--header 'Authorization: Basic <encoded-value>'{
"description": "<h1>Welcome to our Competition</h1>",
"divisions": [
{
"events": [
"ce_123abc"
],
"females_required": null,
"id": "cd_123abc",
"kind": "individual",
"males_required": null,
"name": "Division name",
"order": 0,
"registration_count": 0,
"registration_limit": null,
"team_size": null,
"visible": true
}
],
"events": [
{
"deadline": null,
"deadline_buffer": 0,
"foundations_workout": null,
"id": "ce_123abc",
"instructions": null,
"kind": "individual",
"name": "Event name",
"order": 0,
"released_at": null,
"scaled_workout": null,
"score_visibility": "immediate",
"tie_break": "none",
"visible": true,
"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"
}
}
],
"id": "comp_123abc",
"name": "Competition name",
"registration_closes_at": null,
"registration_opens_at": "2000-01-01T00:00:00Z",
"status": "published",
"time_zone": "America/NewYork",
"video_url": "https://www.youtube.com/watch?v=C0DPdy98e4c"
}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 competition to get
Response
A competition at your organization
Competition description
List of divisions in the competition
A division in a competition
List of events in this division
Event ID
Division ID
Division kind
team, individual Division name
Division order
Division registration count
Required number of female participants
Required number of male participants
Division registration limit
Division team size
Division visibility
List of events in the competition
An event in a competition
Score logging deadline buffer
Event ID
Division kind
team, individual Event name
Event order
When can scores be seen
immediate, deadline, athlete Tie break calculation
none, time_desc, time_asc Event visibility
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"
}
Score logging deadline
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"
}
Event instructions
Event release time.
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"
}
Competition ID
Competition name
Competition status
published, draft Competition time zone
When competition registration closes. ISO8601 timestamp in UTC
When competition registration opens. ISO8601 timestamp in UTC
Competition video URL
curl --request GET \
--url https://api.wodup.dev/api/public/competitions/{id} \
--header 'Authorization: Basic <encoded-value>'{
"description": "<h1>Welcome to our Competition</h1>",
"divisions": [
{
"events": [
"ce_123abc"
],
"females_required": null,
"id": "cd_123abc",
"kind": "individual",
"males_required": null,
"name": "Division name",
"order": 0,
"registration_count": 0,
"registration_limit": null,
"team_size": null,
"visible": true
}
],
"events": [
{
"deadline": null,
"deadline_buffer": 0,
"foundations_workout": null,
"id": "ce_123abc",
"instructions": null,
"kind": "individual",
"name": "Event name",
"order": 0,
"released_at": null,
"scaled_workout": null,
"score_visibility": "immediate",
"tie_break": "none",
"visible": true,
"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"
}
}
],
"id": "comp_123abc",
"name": "Competition name",
"registration_closes_at": null,
"registration_opens_at": "2000-01-01T00:00:00Z",
"status": "published",
"time_zone": "America/NewYork",
"video_url": "https://www.youtube.com/watch?v=C0DPdy98e4c"
}