Awards

Get A Specific User Award

This endpoint retrieves the details of a specific award that has been awarded to a particular user. <h3>Required Scope</h3>awards:read or awards:write

get/api/v2/awards/{id}

Request

  • Base URL
    https://api.betatest.degreed.com
  • URL
    https://api.betatest.degreed.com/api/v2/awards/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the award to retrieve.

Response

Success

Example response

{
  "data": {
    "type": "awards",
    "id": "y3NZL",
    "attributes": {
      "title": "Eater of Bugs",
      "issued-by": "Degreed"
    },
    "relationships": [
      {
        "user": {
          "data": {
            "id": "Bz64P",
            "type": "users"
          }
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.