GET
/
api
/
public
/
competitions
List competitions
curl --request GET \
  --url https://api.wodup.dev/api/public/competitions \
  --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

​
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

Query Parameters

​
limit
integer
default:10

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Required range: 1 <= x <= 100
​
after_cursor
string

A 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.

​
before_cursor
string

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

200 - application/json

list competitions response

​
description
string
required

Competition description

​
divisions
Division · object[]
required

List of divisions in the competition

​
events
Event · object[]
required

List of events in the competition

​
id
string
required

Competition ID

​
name
string
required

Competition name

​
status
enum<string>
required

Competition status

Available options:
published,
draft
​
time_zone
string
required

Competition time zone

​
registration_closes_at
string<timestamptz>

When competition registration closes. ISO8601 timestamp in UTC

​
registration_opens_at
string<timestamptz>

When competition registration opens. ISO8601 timestamp in UTC

​
video_url
string

Competition video URL