Users & Participants

Search…
Institution and course owner
Users exist in a variety of levels in Eduflow. Institutions and courses allow direct access to their owner. In GraphQL, these are associated with the User object type.
Institution owner
Query
Response
1
{
2
  institution {
3
    name
4
    owner {
5
      name
6
      email
7
    }
8
  }
9
}
Copied!
1
{
2
  "data": {
3
    "institution": {
4
      "name": "Dunder Mifflin",
5
      "owner": {
6
        "name": "Michael Scott",
7
        "email": "[email protected]"
8
      }
9
    }
10
  }
11
}
Copied!
Course owner
Query
Response
1
{
2
  course(id: "00000000-5945-95c7-65fd-a9747b200320") {
3
    owner {
4
      name
5
      email
6
    }
7
  }
8
}
Copied!
1
{
2
  "data": {
3
    "course": {
4
      "owner": {
5
        "name": "John Smith",
6
        "email": "[email protected]"
7
      }
8
    }
9
  }
10
}
Copied!
Course participants
In courses, users are queried through a pageable connection: Course.participants. Since course users have course-specific context associated them (their participant type and status), their User objects are wrapped in Participant. 
Participant types: Owner (creator of course),  Admins, Instructors, Assistants and Students.
Query
Response
1
{
2
  course(id: "00000000-5944-95c7-65fc-a9747b200320") {
3
    participants(first: 5) {
4
      edges {
5
        node {
6
          participantType
7
          participantStatus
8
          user {
9
            name
10
            email
11
          }
12
        }
13
      }
14
    }
15
  }
16
}
17
​
Copied!
1
{
2
  "data": {
3
    "course": {
4
      "participants": {
5
        "edges": [
6
          {
7
            "node": {
8
              "participantType": "Owner",
9
              "participantStatus": "ACTIVE",
10
              "user": {
11
                "name": "Michael Scarn",
12
                "email": "[email protected]"
13
              }
14
            }
15
          },
16
          {
17
            "node": {
18
              "participantType": "Teacher",
19
              "participantStatus": "ACTIVE",
20
              "user": {
21
                "name": "John Doe",
22
                "email": "[email protected]"
23
              }
24
            }
25
          },
26
          {
27
            "node": {
28
              "participantType": "Teacher",
29
              "participantStatus": "ACTIVE",
30
              "user": {
31
                "name": "Gyro",
32
                "email": "[email protected]"
33
              }
34
            }
35
          },
36
          {
37
            "node": {
38
              "participantType": "Assistant",
39
              "participantStatus": "ACTIVE",
40
              "user": {
41
                "name": "Dwight Schrute",
42
                "email": "[email protected]"
43
              }
44
            }
45
          },
46
          {
47
            "node": {
48
              "participantType": "Student",
49
              "participantStatus": "ACTIVE",
50
              "user": {
51
                "name": "Jim Halpert",
52
                "email": "[email protected]"
53
              }
54
            }
55
          }
56
        ]
57
      }
58
    }
59
  }
60
}
Copied!
Searching by username
Query
Result
1
{
2
  course(id: "00000000-5945-95c7-65fc-a9747b2003210") {
3
    participants(first: 1, searchTerm: "Angela") {
4
      edges {
5
        node {
6
          participantType
7
          participantStatus
8
          user {
9
            name
10
            email
11
          }
12
        }
13
      }
14
    }
15
  }
16
}
Copied!
1
{
2
  "data": {
3
    "course": {
4
      "participants": {
5
        "edges": [
6
          {
7
            "node": {
8
              "participantType": "Student",
9
              "participantStatus": "ACTIVE",
10
              "user": {
11
                "name": "Angela Martin",
12
                "email": "[email protected]"
13
              }
14
            }
15
          }
16
        ]
17
      }
18
    }
19
  }
20
}
Copied!
Searching by participant type:
Query
Response
1
{
2
  course(id: "00000000-5945-95c7-65fc-a9747b200120") {
3
    participants(first: 5, participantTypeFilter: Student) {
4
      edges {
5
        node {
6
          participantType
7
          participantStatus
8
          user {
9
            name
10
            email
11
          }
12
        }
13
      }
14
    }
15
  }
16
}
Copied!
1
{
2
  "data": {
3
    "course": {
4
      "participants": {
5
        "edges": [
6
          {
7
            "node": {
8
              "participantType": "Student",
9
              "participantStatus": "ACTIVE",
10
              "user": {
11
                "name": "Pam Beesly",
12
                "email": "[email protected]"
13
              }
14
            }
15
          },
16
          {
17
            "node": {
18
              "participantType": "Student",
19
              "participantStatus": "ACTIVE",
20
              "user": {
21
                "name": "Ryan Howard",
22
                "email": "[email protected]"
23
              }
24
            }
25
          },
26
          {
27
            "node": {
28
              "participantType": "Student",
29
              "participantStatus": "ACTIVE",
30
              "user": {
31
                "name": "Kevin Malone",
32
                "email": "[email protected]"
33
              }
34
            }
35
          },
36
          {
37
            "node": {
38
              "participantType": "Student",
39
              "participantStatus": "ACTIVE",
40
              "user": {
41
                "name": "Andy Bernard",
42
                "email": "[email protected]"
43
              }
44
            }
45
          },
46
          {
47
            "node": {
48
              "participantType": "Student",
49
              "participantStatus": "ACTIVE",
50
              "user": {
51
                "name": "Phyllis Smith",
52
                "email": "[email protected]"
53
              }
54
            }
55
          }
56
        ]
57
      }
58
    }
59
  }
60
}
Copied!
Individual participant lookup
Query
Response
1
{
2
  course(id: "00000000-5943-95c7-65fc-a9747b200320") {
3
    participant(id: "UGAydGljaXBhbnQ6MTgzMjY2OTYtMDVhYy00NTdiLTkw") {
4
      participantType
5
      participantStatus
6
      user {
7
        name
8
        email
9
      }
10
    }
11
  }
12
}
13
​
Copied!
1
{
2
  "data": {
3
    "course": {
4
      "owner": {
5
        "name": "Pam Beesly",
6
        "email": "[email protected]"
7
      }
8
    }
9
  }
10
}
Copied!
Guides - Previous
Discussions
Next - Guides