Courses
Instructors can create courses. When an instructor creates a course, the course is associated to the instructor's institution.
Courses always have exactly one institution.
Course participants
Course Participants are a roster of instructors and students in a course. When an instructor adds them through the course's s participants page, they will be a course participant. If they're not already an Institution participant, they'll also be linked to the institution the course belongs to.
Participants can be one type in a course: Owner
, Instructor
, Student
, or Assistant
Invite links
The invite link for learners can be configured through the course participants page. In the example below they are queryable via joinUrl
.
Querying
Listing (inside institution)
{
institution {
courses {
edges {
node {
id
title
joinUrl
flows {
title
}
}
}
}
}
}
via ID
{
course(id: "00000000-5945-95c7-65fc-a9747b300320") {
id
title
joinUrl
flows {
title
}
}
}
Mutations
Inviting participants
You can invite Instructors and Students (learners) via addCourseParticipants
mutation {
addCourseParticipants(
courseId: "00000000-5945-95c7-65fc-a9747b200311",
inviteNow: true,
invitees: [
{name: "Thomas Smith", email: "[email protected]"}
],
participantType: Student
) {
newParticipants {
id
participantType
participantStatus
user {
name
}
}
}
}
Invite participants: Invite links
Invitation links and embed (a.k.a magic links) can be accessed through the Participant
response object:
mutation {
addCourseParticipants(
courseId: "00000000-5945-95c7-65fc-a9747b200311",
inviteNow: false,
invitees: [
{name: "Thomas Smith", email: "[email protected]"}
],
participantType: Student
) {
newParticipants {
id
participantType
participantStatus
user {
name
}
invitationLink
embedLoginLink
}
}
}
invitationLink
: Will prompt user to create a passwordembedLoginLink
: "Magic link", takes user directly to to course
Removing participants
You can remove participants from course by email via removeCourseParticipants
mutation {
removeCourseParticipants(
courseId: "00000000-5945-95c7-65fc-a9747b200311",
participantEmails: ["[email protected]"]
) {
removedUsers {
name
email
}
course {
title
}
}
}
Last updated
Was this helpful?