GET /api/:space/competitions/simple

Description:

Returns a simplified list of Competitions.

Resource URL:

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

Request header

Key	Value	Required
X-API-KEY	Your unique API key	Yes
Content-Type	application/json	Yes

Request URL parameter

Parameter	Type	Required	Description
space	String	Yes	This is the space name which is linked to the account

Additional Query String Parameters

You can use the query parameters along with the generic parameters.

Query parameters

Parameter	Type	Constraint	Usage
competitionType	String	Case sensitive	?competitionType=search_word (you can find the Enum list in the Competitions model)
entrantMemberType	String	Case sensitive	?entrantMemberType=search_word (you can find the Enum list in the Competitions model)
numberOfRounds	Integer	Numbers only	?numberOfRounds=search_number
numberOfGroupStages	Integer	Numbers only	?numberOfGroupStages=search_number
label	String	Case insensitive. For lookup you would use "label.raw=search_word" because the field "label" is indexed to support more complex searches	?label.raw=search_word
description	String	Case sensitive	?description=search_word
termsConditions	String	Case sensitive	?termsConditions=search_word
options	Object	Complex search applies, allows full search on a complex object of Option	?options.numberOfEntrants.minimum=search_number ?options.numberOfEntrants.maximum=search_number ?options.products.name.raw=search_word ?options.products.productType=search_word ?options.products._searchFields=description&_searchFor=search_word ?options.products.adjustmentFactor=search_number ?options.products.productRefId=search_word ?options.products.actionAdjustmentFactors.ruleActionHelper.key=search_word ?options.products.actionAdjustmentFactors.adjustmentFactor=search_number ?options.products.metadata.key=search_word ?options.products.metadata.value=search_number ?options.products.created=search_DateTime ?options.products.id=search_string ?options.ruleSets.priority=search_number ?options.ruleSets.scope=search_word ?options.ruleSets.action=search_word ?options.ruleSets.conditions.matchCondition=search_word (you can find the Enum list in the MainConditionSet model) ?options.ruleSets.conditions.mustEvaluateTo=search_word ?options.ruleSets.conditions.rules.fact=search_word ?options.ruleSets.conditions.rules.operator=search_word ?options.ruleSets.conditions.rules.constant=search_word ?options.ruleSets.conditions.rules.id=search_string ?options.ruleSets.conditions.rules.subConditions.matchCondition=search_word (you can find the Enum list in the SubConditionSet model) ?options.ruleSets.conditions.rules.subConditions.musteEvaluateTo=search_word ?options.ruleSets.conditions.rules.subConditions.subRules.fact=search_word ?options.ruleSets.conditions.rules.subConditions.subRules.operator=search_word ?options.ruleSets.conditions.rules.subConditions.subRules.constant=search_word ?options.scheduledDates.start=search_DateTime ?options.scheduledDates.end=search_DateTime ?options.actualDates.start=search_DateTime ?options.actualDates.end=search_DateTime ?options.limitEntrantsTo=search_word ?options.optinRequiredForEntrans=search_word ?option.notification.messageid=search_string ?options.notification.competitionStatus=seach_word (you can find the Enum list in the Notification model) ?options.notification.contestStatus=search_word (you can find the Enum list in the Notification model)
metadata	Array [Object]	Complex search applies, allows full search on a complex object of Metadata	?metadata.key=search_word ?metadata.value=search_number
status	String	Case sensitive	?status=search_word (you can find the Enum list in the Competitions model)
statusCode	Integer	Numbers only	?statusCode=search_number (you can find the Enum list in the Competitions model)
created	DateTime	Works with simple dates or date and time, eg: created=2016-02-07, created=2018-08-23T14:23:09	?created=search_DateTime
id	String	Case sensitive	?id=search_string

EXAMPLE

Request

curl
--header "X-API-KEY: <your-api-key>"
--request GET https://app.competitionlabs.com/api/<your-space-name>/competitions/simple

Response

{
    "meta": {
        "totalRecordsFound": 3,
        "skip": 0,
        "limit": 20
    },
    "data": [
        {
            "statusCode": 3,
            "numberOfRounds": 1,
            "description": "test",
            "label": "test",
            "id": "sD7ZUWUBeag0_3vrb6kW",
            "status": "Ready"
        },
        {
            "statusCode": 9,
            "numberOfRounds": 1,
            "description": "ass",
            "label": "ass",
            "id": "mHijn2UB8HzUh8MGdnCF",
            "status": "Cancelled"
        },
        {
            "statusCode": 7,
            "numberOfRounds": 1,
            "description": "ASDSA",
            "label": "ASDSA",
            "id": "oXgEoGUB8HzUh8MGNHAf",
            "status": "Finished"
        }
    ]
}

Request with Query string parameters

curl
--header "X-API-KEY: <your-api-key>"
--request GET https://app.competitionlabs.com/api/<your-space-name>/competitions/simple?status=Finished&statusCode=7

Response for Query string request

{
    "meta": {
        "totalRecordsFound": 1,
        "skip": 0,
        "limit": 20
    },
    "data": [
        {
            "statusCode": 7,
            "numberOfRounds": 1,
            "description": "ASDSA",
            "label": "ASDSA",
            "id": "oXgEoGUB8HzUh8MGNHAf",
            "status": "Finished"
        }
    ]
}

ERROR CODES

Code	HTTP Status	Description	Example
1007	404	Competition with CL-compId not found for the accountId	Error Response 404 Expand source { "errors": [ { "message": "Competition with CL-compId: simple.status=Finished&statusCode=7 not found for the account: QmTaPGUBsZyUBGOR_u9A.", "code": 1007, "status": 404 } ] }