List Course Users
Lists course users in Canvas LMS.
This node is also exposed as an AI Agent tool.
This node has 1 input port and 1 output port.
Common Properties
Every node shares these.
- Name — the node's display name on the canvas.
- Color — the node's colour on the canvas.
- Delay Before (sec) — wait this long before the node runs.
- Delay After (sec) — wait this long after the node runs.
- Continue On Error — carry on instead of failing the flow. Defaults to false.
info
When Continue On Error is true the error is not raised at all, so a Catch node will not see it either.
Inputs
| Property | Field | Description |
|---|---|---|
| Client ID | inClientID | Client ID from Connect node |
| Course ID | inCourseID | The course to list users for |
Outputs
| Property | Field | Description |
|---|---|---|
| Count | outCount | Number of users returned |
| Users | outUsers | Array of user objects |
Options
| Property | Field | Description |
|---|---|---|
| Credentials | optCredentials | Canvas API credentials |
| Enrollment Type | optEnrollmentType | Filter by enrollment type One of: ALL, student, teacher, ta, observer, designer. |
| Per Page | optPerPage | Number of results per page (max 100) |
| Search Term | optSearchTerm | Search by name or email |
Requirements
- A Client ID from this package's Connect node, unless you set credentials directly on this node.
- Canvas API Token — API access token for Canvas LMS authentication
url— Canvas URL (text, required). Your Canvas instance URL (without trailing slash)value— API Token (password, required). API access token from Canvas account settings
Store these in a Vault and reference the vault item from the node, rather than typing the secret into the property.
Related nodes
Elsewhere in the package: Connect · Disconnect · List Courses · Get Course · List Assignments · Get Assignment · Create Assignment · Update Assignment · Delete Assignment · List Enrollments and 10 more
See also
- Canvas LMS — every node in this package
- Message object — how properties read values from
msg - Handling failure — Continue On Error, Catch and retries