Awareness
Team awareness

List all employees' courses progress

Retrieves a paginated list of all employees and their progress across all courses in the workspace's awareness program, as well as courses they followed outside of it. For each employee, returns detailed information including their identification data and a comprehensive breakdown of their course progress. For program courses, the response includes the completion status of each course for all program years up to the employee's current program year, or up to the employee's current mission in the mission system. The status is completed, missed, or upcoming. In the mission system, only completed and upcoming are emitted. For courses followed outside the program, only the completion status is returned and years is an empty array. In the mission system, such a course is not reported when the employee started it before the workspace moved to missions and never completed it.

Scopes required:

  • awareness:read
get/v1/courses/employees_progress

Request

  • Base URL: https://public-api.tryriot.com
  • URL: https://public-api.tryriot.com/v1/courses/employees_progress
  • Auth: API key in header x-api-key

Query parameters

cursorstring

Pagination cursor for retrieving the next page of results. This value is obtained from the 'x-next-cursor' response header of a previous API call. The cursor should be passed unchanged to fetch next pages. See https://docs.tryriot.com/api-reference/introduction#pagination for examples.

limitinteger

Maximum number of items to return. Maximum value is 500.

workspace_idstring uuid required

ID of the workspace for which to retrieve employees

Headers

x-item-limitinteger

Maximum number of items to return. Maximum value is 500.

x-next-cursorstring

Pagination cursor for retrieving the next page of results. This value is obtained from the 'x-next-cursor' response header of a previous API call. The cursor should be passed unchanged to fetch next pages. See https://docs.tryriot.com/api-reference/introduction#pagination for examples.

Response

Employees courses progress

Example response

{
  "data": [
    {
      "courses_progress": [
        {
          "course": {
            "description": "Learn how to manage your digital presence effectively",
            "name": "Digital Footprint",
            "slug": "digital_footprint"
          },
          "quiz_score": "4/5",
          "years": [
            {
              "quiz_score": "4/5"
            }
          ]
        }
      ],
      "employee": {
        "name": "John Doe",
        "primary_email_address": "john.doe@tryriot.com"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.