GET /api/:space/reward

Description:

Returns a list of rewards.

Resource URL:

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

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 for Contests

Parameter	Type	Constraint	Usage
entityId	String	Case sensitive	?entityId=search_word
rewardRank	String	Case sensitive	?rewardRank=search_word
rewardName	String	Case sensitive. For lookup you would use "rewardName.raw=search_word" because the field "rewardName" is indexed to support more complex searches	?rewardName.raw=search_word
value	Double	Case sensitive	?value=search_word
rewardType	String	Case sensitive Query with the reward type Id	?rewardType=search_word
description	String	Case sensitive	?description=search_word
delay	Integer	Numbers only	?delay=search_number
memberAcknowledgmentRequired	Boolean	Case sensitive	?memberAcknowledgmentRequired=search_word
metadata	Array [Object]	Complex search applies, allows full search on a complex object of Metadata	?metadata.key=search_word ?metadata.value=search_number
pointInTime	DateTime	Case sensitive Works with simple dates or date and time, example: pointInTime=2016-02-07, pointInTime=2018-08-23T14:23:09 If a response gives "pointInTime"="2018-12-11T11:18:56.546+0000" then the value you can use is up to "2018-12-11T11:18:56.546"	?pointInTime=search_word
period	Integer	Numbers only	?period=search_number
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>/reward

Response

{
    "meta": {
        "totalRecordsFound": 12,
        "skip": 0,
        "limit": 20
    },
    "data": [
        {
            "jsonClass": "Reward",
            "entityId": "J7OrzmUBOmEkXOJn8GTb",
            "rewardRank": "1",
            "rewardName": "test",
            "value": 1,
            "rewardType": "RmTbPGUBsZyUBGORB-_M",
            "description": "test",
            "delay": 0,
            "memberAcknowledgmentRequired": false,
            "metadata": [
                {
                    "jsonClass": "Metadata",
                    "key": "1",
                    "value": "1"
                }
            ],
            "accountId": "QmTaPGUBsZyUBGOR_u9A",
            "pointInTime": "2018-09-12T16:44:59.497+00:00",
            "created": "2018-09-12T16:44:59.497+00:00",
            "id": "KLOrzmUBOmEkXOJn8GTp",
            "translations": {},
            "translatableFields": [
                "rewardName",
                "description"
            ]
        }
    ]
}

Request with Query string parameters

curl
--header "X-API-KEY: <your-api-key>"
--request GET https://app.competitionlabs.com/api/<your-space-name>/reward?rewardRank=1&_limit=2

Response for Query string request

{
    "meta": {
        "totalRecordsFound": 7,
        "skip": 0,
        "limit": 2
    },
    "data": [
        {
            "jsonClass": "Reward",
            "entityId": "pT7HTWUBeag0_3vrF6kP",
            "rewardRank": "1",
            "rewardName": "test2",
            "value": 1,
            "rewardType": "RmTbPGUBsZyUBGORB-_M",
            "description": "test",
            "delay": 0,
            "memberAcknowledgmentRequired": false,
            "metadata": [],
            "accountId": "QmTaPGUBsZyUBGOR_u9A",
            "pointInTime": "2018-08-18T16:03:37.941+00:00",
            "created": "2018-08-18T16:03:37.948+00:00",
            "id": "pj7HTWUBeag0_3vrF6lc",
            "translations": {},
            "translatableFields": [
                "rewardName",
                "description"
            ]
        },
        {
            "jsonClass": "Reward",
            "entityId": "J7OrzmUBOmEkXOJn8GTb",
            "rewardRank": "1",
            "rewardName": "test",
            "value": 1,
            "rewardType": "RmTbPGUBsZyUBGORB-_M",
            "description": "test",
            "delay": 0,
            "memberAcknowledgmentRequired": false,
            "metadata": [
                {
                    "jsonClass": "Metadata",
                    "key": "1",
                    "value": "1"
                }
            ],
            "accountId": "QmTaPGUBsZyUBGOR_u9A",
            "pointInTime": "2018-09-12T16:44:59.497+00:00",
            "created": "2018-09-12T16:44:59.497+00:00",
            "id": "KLOrzmUBOmEkXOJn8GTp",
            "translations": {},
            "translatableFields": [
                "rewardName",
                "description"
            ]
        }
    ]
}

ERROR CODES

Code	HTTP Status	Description	Example
	404	The Request URL is incorrect	Error Response 404 Expand source { "status": 404 }
1009	500	Query with an incorrect query that is case sensitive	Error Response 500 Expand source { "errors": [ { "message": "Error occurred while trying to process the request, please try again.", "code": 1009, "status": 500 } ] }