POST /api/:space/reward/list

Description:

Returns a list of rewards for the ID's specified in an array.

Resource URL:

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

Request headers

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

Request URL parameters

Parameter
Type
Required
Description
space
StringYes

This is the space name which is linked to the account

EXAMPLE

Request
curl
--header "X-API-KEY: <your-api-key>"
--header "Content-Type: application/json"
--request POST https://app.competitionlabs.com/api/<your-space-name>/reward/list
-d '["KLOrzmUBOmEkXOJn8GTp","aLPww2UBOmEkXOJnMWPm"]'
Response
{
    "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"
            ]
        },
        {
            "jsonClass": "Reward",
            "entityId": "Z7Pww2UBOmEkXOJnMWPY",
            "rewardRank": "sadasd",
            "rewardName": "asdsasd",
            "value": 1,
            "rewardType": "RWTbPGUBsZyUBGORB--4",
            "description": "asdda",
            "delay": 0,
            "memberAcknowledgmentRequired": false,
            "metadata": [
                {
                    "jsonClass": "Metadata",
                    "key": "1",
                    "value": "1"
                }
            ],
            "accountId": "QmTaPGUBsZyUBGOR_u9A",
            "pointInTime": "2018-09-10T14:43:43.206+00:00",
            "created": "2018-09-10T14:43:43.206+00:00",
            "id": "aLPww2UBOmEkXOJnMWPm",
            "translations": {},
            "translatableFields": [
                "rewardName",
                "description"
            ]
        }
    ]
}

ERROR CODES

CodeHTTP StatusDescriptionExample

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