GET reward/{rewardId}

Related

Get the info of a reward.

Example

GET /api/v1/reward/3ad449b9-ee9f-4558-a547-e85943d99e8f HTTP/1.1
Accept: application/json
----------------------------------------
HTTP/1.1 200 OK
Content-Type: application/json
ETag: ...

{
  "id": "3ad449b9-ee9f-4558-a547-e85943d99e8f",
  "name": "Test 01 Reward A",
  "description": "Get this by achieving Test 01",
  "kind": "emblem",
  "data": {
    "image": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/ec9fbd31-d78a-44ac-8566-3500cd1953bc.jpg",
    "color": "#00ff00"
  },
  "achievementKey": "test-01"
}

Security

Authentication is not required for this method.

URL Parameters

NameDescriptionValue
rewardIdthe ID of the reward, as a GUID with dashesstring

Query Parameters

NONE

Request Body

NONE

Response

Successful responses are code 200 with data in the response body. Error responses are standard.

Response Body

NameDescriptionValue
idthe ID of the reward, as a GUID with dashesstring
namethe name of the rewardstring
descriptionthe description of the rewardstring
kinda type discriminator for this rewardstring
datatype-specific data for this rewardobject
achievementKeythe key of the achievement with which this reward is associatedstring