GET achievements

Get the list of achievements available in the system along with the associated rewards.

Example

GET /api/v1/achievements HTTP/1.1
Accept: application/json
Authorization: Bearer ...
----------------------------------------
HTTP/1.1 200 OK
Content-Type: application/json
ETag: ...

[
  {
    "key": "test-01",
    "name": "Test 01",
    "description": "This is a test achievement.",
    "visibilityStart": null,
    "visibilityStop": null,
    "rewards": [
      {
        "id": "3ad449b9-ee9f-4558-a547-e85943d99e8f",
        "name": "Test 01 Reward A",
        "kind": "emblem",
        "data": {
          "image": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/ec9fbd31-d78a-44ac-8566-3500cd1953bc.jpg",
          "color": "#00ff00"
        },
        "achievementKey": "test-01"
      },
      {
        "id": "33587ceb-23b9-4f03-b4be-acaebe22bacb",
        "name": "Test 01 Reward B",
        "kind": "emblem",
        "data": {
          "image": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/ec9fbd31-d78a-44ac-8566-3500cd1953bc.jpg",
          "color": "#0000ff"
        },
        "achievementKey": "test-01"
      }
    ]
  },
  {
    "key": "test-02",
    "name": "Test 02",
    "description": "This is a test achievement.",
    "image": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/ec9fbd31-d78a-44ac-8566-3500cd1953bc.jpg",
    "visibilityStart": 1558149343,
    "visibilityStop": 1558754143,
    "rewards": []
  }
]

Security

Authentication is not required for this method.

URL Parameters

NONE

Query Parameters

NONE

Request Body

NONE

Response

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

Response Body

The response body is an Array of Achievement objects.

Achievement

Reward