List courses status of employees

Lists the employees the course was delivered to, ordered by their creation date (most recent first). An employee is listed as soon as the course reaches them, whether or not they have started it.

For courses in the workspace's awareness program, the current year's enrolment status is provided along with a history of course statuses from previous years, or up to the employee's current mission in the mission system.

For courses followed outside the program, years is always empty and status is either completed or upcoming based on whether the employee finished the course.

Scopes required:

awareness:read

get/v1/courses/{course_id}

Request

Base URL: https://public-api.tryriot.com
URL: https://public-api.tryriot.com/v1/courses/{course_id}
Auth: API key in header x-api-key

Path parameters

course_idstring uuid required

ID of the course for which to retrieve employee statuses

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 100.

workspace_idstring uuid required

ID of the workspace for which to retrieve employees

statusEmployeeCourseStatusSchema[]

Filters employees based on their course status. Accepts a comma-separated string of status values.

Headers

x-item-limitinteger

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

x-next-cursorstring

Response

Courses statuses list of employees

Example response

{
  "data": [
    {
      "employee": {
        "name": "John Doe",
        "primary_email_address": "john.doe@tryriot.com"
      },
      "quiz_score": "4/5",
      "years": [
        {
          "quiz_score": "4/5"
        }
      ]
    }
  ]
}

Changes

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