Skip to main content
GET
/
v1
/
courses
/
{course_id}
List courses status of employees
curl --request GET \
  --url https://public-api.tryriot.com/v1/courses/{course_id} \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "employee": {
        "id": "e4ebfd69-3c2c-4028-b423-1bff3d87d58f",
        "name": "John Doe",
        "primary_email_address": "[email protected]",
        "username": "<string>"
      },
      "status": "upcoming",
      "years": [
        {
          "completed_at": "2024-01-13T10:00:00.000000Z",
          "due_at": "2024-01-13T10:00:00.000000Z",
          "status": "upcoming",
          "year": 2
        }
      ]
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-item-limit
integer
default:50

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

Required range: 1 <= x <= 100
​
x-next-cursor
string

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.

Path Parameters

​
course_id
string<uuid>
required

ID of the course for which to retrieve the stats

Query Parameters

​
workspace_id
string<uuid>
required

ID of the workspace for which to retrieve employees

​
status
enum<string>[]

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

Response

Courses statuses list of employees

​
data
PaginatedCourseStatusPayload · object[]
required
⌘I