GET /api/:space/reward/entity/:entityId

Description:

Returns reward details for the entity ID specified.

Resource URL:

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

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

entityId
StringYesReward entity identifier retrieved from public GET Rewards resource

EXAMPLE

Request 
curl
--header "X-API-KEY: <your-api-key>"
--request GET https://app.competitionlabs.com/api/<your-space-name>/reward/entity/J7OrzmUBOmEkXOJn8GTb
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"
            ]
        }
    ]
}

ERROR CODES

CodeHTTP StatusDescriptionExample
1007404No Id was inserted in the Request URL
Error Response 404 
{
    "errors": [
        {
            "message": "A record with requested id was not found.",
            "code": 1007,
            "status": 404
        }
    ]
}

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