Courses

Search…
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
Querying
Listing (inside institution)
Query
Response
1
{
2
  institution {
3
    courses {
4
      edges {
5
        node {
6
          id
7
          title
8
          flows {
9
            title
10
          }
11
        }
12
      }
13
    }
14
  }
15
}
16
​
Copied!
1
{
2
  "data": {
3
    "institution": {
4
      "courses": {
5
        "edges": [
6
          {
7
            "node": {
8
              "id": "00000000-5945-95c7-65fc-a9747b200320",
9
              "title": "Onboarding (New Employees)",
10
              "flows": [
11
                {
12
                  "title": "Root flow"
13
                },
14
                {
15
                  "title": "Corporate Culture"
16
                },
17
                {
18
                  "title": "Paper in the 2000's"
19
                }
20
              ]
21
            }
22
          },
23
          {
24
            "node": {
25
              "id": "00000000-5945-95c7-65fc-a9747b200317",
26
              "title": "History of Dunder-Mifflin",
27
              "flows": [
28
                {
29
                  "title": "Welcome to History of Dunder-Mifflin"
30
                },
31
                {
32
                  "title": "Founding a Company"
33
                }
34
              ]
35
            }
36
          }
37
        ]
38
      }
39
    }
40
  }
41
}
Copied!
via ID
Query
Response
1
{
2
  course(id: "00000000-5945-95c7-65fc-a9747b300320") {
3
    id
4
    title
5
    flows {
6
      title
7
    }
8
  }
9
}
Copied!
1
{
2
  "data": {
3
    "course": {
4
      "id": "00000000-5945-95c7-65fc-a9747b200320",
5
      "title": "Onboarding (New Employees)",
6
      "flows": [
7
        {
8
          "title": "Root flow"
9
        },
10
        {
11
          "title": "Corporate Culture"
12
        },
13
        {
14
          "title": "Paper in the 2000's"
15
        }
16
      ]
17
    }
18
  }
19
}
Copied!
Mutations
Inviting participants
You can invite Instructors and Students (learners) via addCourseParticipants
Query
Response
1
mutation {
2
  addCourseParticipants(
3
    courseId: "00000000-5945-95c7-65fc-a9747b200311", 
4
    inviteNow: true, 
5
    invitees: [
6
      {name: "Thomas Smith", email: "[email protected]"}
7
    ],
8
    participantType: Student
9
  ) {
10
    newParticipants {
11
      id
12
      participantType
13
      participantStatus
14
      user {
15
        name
16
      }
17
    }
18
  }
19
}
20
​
Copied!
1
{
2
  "data": {
3
    "addCourseParticipants": {
4
      "newParticipants": [
5
        {
6
          "id": "UGFydGljaXBhbnQ6OTYyOGYwNGYtNjMyZi00YTZhLWEwMTItMjdkZWZlZTMwNTIv",
7
          "participantType": "Student",
8
          "participantStatus": "INVITATION_PENDING",
9
          "user": {
10
            "name": "Thomas Smith"
11
          }
12
        }
13
      ]
14
    }
15
  }
16
}
Copied!
​
Guides - Previous
Institutions
Next - Guides
Flows and Activities
Last modified 8mo ago
Copy link
Contents
Querying
Mutations