Search Users
search_usersFind Canvas users by name, login, or email within a single account, with optional email, last-login, avatar, time-zone, or UUID fields and sort controls.
Instructions
Search for users in a single Canvas account by name, login, or email, returning matching Canvas user objects. Use include to add email, last_login, avatar_url, time_zone, or uuid to each result, and sort/order to control the ordering. This is one account-scoped search — to check whether one student is enrolled anywhere across an educator's own active and concluded courses, use find_student_across_courses instead; to list every user in one course without a search term, use list_course_users; to list an entire account's users unfiltered, use list_account_users. Because results carry no enrollment data, pseudonymized mode cannot tell staff from students and anonymizes every returned user's name and email.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort field | |
| order | No | Sort order | |
| include | No | Extra fields to include on each user (Canvas include[] param) | |
| account_id | Yes | The Canvas account ID | |
| search_term | Yes | The search term (name, login, or email) |