v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB

Awards

Get All User Awards

This endpoint retrieves all awards for the current organization. <h3>Required Scope</h3>awards:read or awards:write

get/api/v2/awards

Query parameters

nextstring

Retrieves the next batch of awards. This value expires after 2 minutes if a request has not been made during that time.

limitinteger

The maximum number of awards to display per page. A maximum of 1000 is allowed.

Response

Success

Example response

{
  "links": {
    "self": "string"
  },
  "data": [
    {
      "type": "awards",
      "id": "y7Aoy",
      "attributes": {
        "created-at": "2024-11-06T13:58:07.9036775",
        "title": "Top Performer",
        "awarded-at": "2015-04-01T06:00:00",
        "image-url": "~/user-content/useroutcomeimage-8196-ef6c7e7b-215f-4bed-8dc0-94606049bb5c.jpg",
        "url": "https://www.google.com/award/242354",
        "issued-by": "Degreed"
      },
      "links": {
        "self": "string"
      },
      "relationships": [
        {
          "user": {
            "data": {
              "id": "Anonymous",
              "type": "users"
            }
          }
        }
      ]
    }
  ]
}