GET /api/:space/awards/:id

Description:

Returns product details for the identifier specified. Once an award gets issued it gets recorded in an event stream.

Resource URL:

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

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
id	String	Yes	Award identifier

EXAMPLE

Request

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

Response

{
        "accountId": "0sn4DmUBkPH_lz9GgxBM",
        "memberId": "Cs_QPW0BqLkDAeuv9cxO",
        "reward": {
            "jsonClass": "Reward",
            "entityType": "achievement",
            "entityId": "Z8_hPW0BqLkDAeuvoMz_",
            "rewardRank": "",
            "rewardName": "Tickets to weekly",
            "value": 3.0,
            "rewardType": "1cn4DmUBkPH_lz9GixDL",
            "description": "",
            "delay": 0,
            "memberAcknowledgmentRequired": false,
            "metadata": [],
            "accountId": "0sn4DmUBkPH_lz9GgxBM",
            "created": "2019-09-17T06:21:00.057+0000",
            "id": "aM_hPW0BqLkDAeuvocwZ",
            "translations": {}
        },
        "claimed": true,
        "entityType": "Achievement",
        "entityId": "Z8_hPW0BqLkDAeuvoMz_",
        "created": "2019-09-19T18:10:58.390+0000",
        "id": "ruS4Sm0BBZeE7Tj3WBHW"
    }

ERROR CODES

Code	HTTP Status	Description	Example
	404	No Id for award was inserted in the Request URL	Error Response 404 Expand source { "status": 404 }
1007	404	A record with requested id was not found	Error Response 404 Expand source { "errors": [ { "message": "A record with requested id was not found.", "code": 1007, "status": 404 } ] }