GET /api/:space/competitions/enums/list

Description:

Returns a list of possible enums in competitions model.

Resource URL:

https://<apphost>.competitionlabs.com/api/<your-space-name>/competitions/enums/list

Request headers

KeyValueRequired
X-API-KEY
Your unique API keyYes
Content-Type
application/jsonYes

Request URL parameters

Parameter
Type
Required
Description
space
StringYesThis is the space name which is linked to the account

EXAMPLE

Request
curl
--header "X-API-KEY: <your-api-key>"
--request GET https://app.competitionlabs.com/api/<your-space-name>/competitions/enums/list
Response
{
    "data": {
        "competitionTypes": [
            "Leaderboard",
            "Elimination",
            "Challenge",
            "RoundRobin"
        ],
        "competitionStatus": [
            "Unknown",
            "Deleting",
            "Deleted",
            "Draft",
            "Template",
            "Preparing",
            "Ready",
            "Starting",
            "Active",
            "Finishing",
            "Finished",
            "Cancelling",
            "Cancelled"
        ],
        "roundTypes": [
            "TargetBased",
            "TimeBound"
        ],
        "contestStyles": [
            "EntrantVsEntrant",
            "EntrantVsEnvironment",
            "EntrantVsGroup"
        ],
        "memberType": [
            "Individual",
            "Team"
        ]
    }
}

ERROR CODES

CodeHTTP StatusDescriptionExample

404The Request URL is incorrect
Error Response 404
{
    "status": 404
}