- Category: online courses
- Auth: OAUTH2, API_KEY
- Composio-managed OAuth available? No
- Tools: 574
- Triggers: 6
- Slug:
CANVAS - Version: 20261101_00
Tools
Abort Quiz Report Generation
Abort Quiz Report Generation
Add conversation message
Add conversation message
CANVAS_ADD_CONVERSATION_MESSAGETool to add a message to an existing Canvas conversation. Use when sending a follow-up message to a conversation thread with specified recipients.Input Parameters
Output
Add course to favorites
Add course to favorites
Add group to favorites
Add group to favorites
Add last attended date
Add last attended date
CANVAS_ADD_LAST_ATTENDED_DATETool to add or update the last attended date for a student enrollment in a course. Use when tracking student attendance by recording the last date a student attended the course.Input Parameters
Output
Add recipients to conversation
Add recipients to conversation
CANVAS_ADD_RECIPIENTS_TO_CONVERSATIONTool to add recipients to an existing group conversation. Use when you need to add new participants to an ongoing conversation. Response includes the latest message showing who was added.Input Parameters
Output
Answer quiz questions
Answer quiz questions
CANVAS_ANSWER_QUIZ_QUESTIONSTool to provide or update answers to quiz questions for a quiz submission. Use when submitting answers for a quiz attempt. Requires a valid validation_token from quiz submission creation and the latest attempt number.Input Parameters
Output
Assign unassigned members to group category
Assign unassigned members to group category
CANVAS_ASSIGN_UNASSIGNED_MEMBERS_TO_GROUP_CATEGORYTool to assign unassigned members to groups within a group category. Use when you need to distribute users who are not yet in any group within the category. Returns a Progress object for async tracking by default, or group memberships when sync=true.Input Parameters
Output
Clear Course Nicknames
Clear Course Nicknames
Close notification for user
Close notification for user
CANVAS_CLOSE_NOTIFICATION_FOR_USERTool to excuse/close an account notification for the current user. Use when the current user no longer wants to see a specific notification. If the remove parameter is set to true, the notification is permanently destroyed for all users (admin action).Input Parameters
Output
Conclude, deactivate, or delete an enrollment
Conclude, deactivate, or delete an enrollment
Copy File to Folder
Copy File to Folder
CANVAS_COPY_FILE_TO_FOLDERCopies an existing Canvas file to a specified destination folder. Use when you need to duplicate a file to another location.Input Parameters
Output
Copy Folder
Copy Folder
Create account notification
Create account notification
CANVAS_CREATE_ACCOUNT_NOTIFICATIONCreates a global notification within a Canvas account, with a visibility period and optional recipient roles.Input Parameters
Output
Create a user content migration
Create a user content migration
CANVAS_CREATE_A_CONTENT_MIGRATION4Tool to create a content migration for a Canvas user. Use when you need to import content into a user’s files from various sources (zip files, cartridges, etc.). If the migration requires a file upload, the actual processing starts once the file upload completes.Input Parameters
Output
Create appointment group
Create appointment group
CANVAS_CREATE_APPOINTMENT_GROUPCreates a new appointment group in Canvas for schedulable time slots within specified course or group contexts.Input Parameters
context_codes.Output
Create an assignment
Create an assignment
CANVAS_CREATE_ASSIGNMENTCreates a new assignment within a specified course in Canvas LMS.Input Parameters
Output
Create assignment via GraphQL
Create assignment via GraphQL
CANVAS_CREATE_ASSIGNMENT_GRAPH_QLTool to create a new assignment in a Canvas course using the GraphQL API. Use when you need to create assignments with detailed configuration options including peer reviews, moderated grading, or assignment overrides.Input Parameters
Output
Create assignment group
Create assignment group
CANVAS_CREATE_ASSIGNMENT_GROUPCreate a new assignment group for a course. Use when you need to add a new assignment group to organize assignments in a Canvas course.Input Parameters
Output
Create assignment override
Create assignment override
CANVAS_CREATE_ASSIGNMENT_OVERRIDECreates an assignment override to adjust due/unlock/lock dates for an assignment in a course, targeting specific students (requires title), a group, or a course section; at least one target (student_ids, group_id, or course_section_id) is required.Input Parameters
student_ids are specified to identify the ad-hoc group.Output
Batch create overrides in a course
Batch create overrides in a course
CANVAS_CREATE_BATCH_OVERRIDES_IN_A_COURSETool to batch create assignment overrides for multiple assignments in a course. Use when creating multiple overrides at once in a transactional manner (all succeed or none are created). Each override requires assignment_id and one of student_ids, group_id, or course_section_id.Input Parameters
Output
Create blackout date for course
Create blackout date for course
Create Bookmark
Create Bookmark
CANVAS_CREATE_BOOKMARKCreates a new bookmark for the authenticated user. Use when you need to save a shortcut link to a Canvas page or external resource for quick access.Input Parameters
Output
Create Calendar Event
Create Calendar Event
CANVAS_CREATE_CALENDAR_EVENTCreates a calendar event with options for recurrence (finite rrule series only), section-specific timings, and blackout dates within a specified context.Input Parameters
start_at and end_at times are ignored (date portion only).ChildEventData objects.Output
Create communication channel
Create communication channel
CANVAS_CREATE_COMMUNICATION_CHANNELCreates a new communication channel (e.g., email, SMS, push) for an existing Canvas user to receive notifications.Input Parameters
Output
Create conversation
Create conversation
CANVAS_CREATE_CONVERSATIONUse to send messages in Canvas by creating a new conversation or adding to an existing one; an existing conversation with the same recipients (and matching scope/filter, if specified) may be reused unless force_new is true.Input Parameters
scope and filter_mode to find an existing conversation to reuse. If a match is found and force_new is not true, that conversation is used/updated instead of creating a new one.filter criteria are combined (‘and’, ‘or’). Used in conjunction with scope and filter to identify an existing conversation for reuse. ‘default’ typically implies ‘and’.force_new is true and a new conversation is created.media_comment_id is provided.Output
Create conversation via GraphQL
Create conversation via GraphQL
CANVAS_CREATE_CONVERSATION_GRAPH_QLTool to create a new conversation (message) between users in Canvas via GraphQL. Use when initiating a new conversation thread with specified recipients.Input Parameters
Output
Create a course
Create a course
CANVAS_CREATE_COURSECreates a new course in Canvas within a specified account, with comprehensive configuration options. Returns a course object including id (course_id); retain this for subsequent module, page, and upload calls.Input Parameters
sis_course_id was previously deleted, this action will attempt to reactivate and update that course instead of creating a new one. Requires sis_course_id to be provided.start_at and end_at dates. Access outside these dates may be restricted.Output
Create Course Grading Standard
Create Course Grading Standard
CANVAS_CREATE_COURSE_GRADING_STANDARDTool to create a new grading standard in a Canvas course. Use when you need to define a custom grading scale with grade labels and percentage thresholds for a specific course.Input Parameters
Output
Create a custom gradebook column
Create a custom gradebook column
CANVAS_CREATE_CUSTOM_GRADEBOOK_COLUMNCreates a new custom gradebook column in a course. Use when you need to add custom tracking fields like participation scores or extra credit to the gradebook.Input Parameters
Output
Create discussion entry
Create discussion entry
Create discussion entry (GraphQL)
Create discussion entry (GraphQL)
Create discussion topic
Create discussion topic
CANVAS_CREATE_DISCUSSION_TOPICCreates a new discussion topic in a specified Canvas course, allowing comprehensive configuration of its content, type, publication settings, engagement features, and associations.Input Parameters
true to pin the topic, listing it in a ‘Pinned Discussions’ section for higher visibility. Defaults to false.true to publish the topic immediately, or false to save it as a draft. Defaults to false if not provided, creating a draft.allow_rating is true, set this to true to sort discussion entries by their ratings. Defaults to false.published should ideally be false or omitted.true to mark this topic as an announcement. Announcements may appear in a special section or have different notification behavior. Defaults to false.true to require users to make an initial post before they can view other replies in the topic. Defaults to false.allow_rating is true, set this to true to restrict rating privileges to graders only. Defaults to false (meaning any user can rate if allow_rating is true).podcast_enabled is true, set this to true to include student posts in the podcast feed. Defaults to false.Output
Create discussion topic (GraphQL)
Create discussion topic (GraphQL)
CANVAS_CREATE_DISCUSSION_TOPIC_GRAPH_QLTool to create a new discussion topic in a course or group using the Canvas GraphQL API. Use when creating discussion topics with the GraphQL interface.Input Parameters
Output
Create enrollment
Create enrollment
CANVAS_CREATE_ENROLLMENTEnrolls a user in a Canvas course with a specified role and status; associated_user_id is required if enrollment_type is ‘ObserverEnrollment’.Input Parameters
Output
Create ePub export
Create ePub export
Create External Feed
Create External Feed
CANVAS_CREATE_EXTERNAL_FEEDCreates a new external RSS or Atom feed for a Canvas course. Use when you need to import external content into a course feed.Input Parameters
Output
Create External Feed for Group
Create External Feed for Group
CANVAS_CREATE_EXTERNAL_FEED_FOR_GROUPTool to create a new external RSS or Atom feed for a Canvas group. Use when you need to import external content into a group feed.Input Parameters
Output
Create external tool
Create external tool
CANVAS_CREATE_EXTERNAL_TOOLTool to create an external tool in a Canvas account. Use when you need to integrate an LTI tool or external application. If a client_id is supplied, Canvas will attempt to create a context external tool using the LTI 1.3 standard.Input Parameters
Output
Create external tool in course
Create external tool in course
CANVAS_CREATE_EXTERNAL_TOOL_IN_COURSETool to create an external tool in the specified course. Use when you need to integrate an LTI tool or external application within a course context. If a client_id is supplied, Canvas will attempt to create a context external tool using the LTI 1.3 standard.Input Parameters
Output
Create Files
Create Files
CANVAS_CREATE_FILESTool to initiate file upload to Canvas (Step 1 of 3-step process). Use when you need to upload a file to a course, user folder, group, or account. This action returns upload_url and upload_params needed for the actual file upload. After calling this, POST the file data to the upload_url with the returned parameters, then follow any redirect to complete the upload.Input Parameters
Output
Create folder
Create folder
CANVAS_CREATE_FOLDERTool to create a folder in the specified context. Use when you need to create a new folder for organizing files in Canvas for a user.Input Parameters
/, never a back slash. The parent folder will be created if it does not already exist. If this and parent_folder_id are sent an error will be returned. If neither is given, a default folder will be used.Output
Create Folder in Group
Create Folder in Group
CANVAS_CREATE_FOLDER_IN_GROUPTool to create a folder within a Canvas group. Use when you need to organize files in a group context.Input Parameters
/, never a back slash. The parent folder will be created if it does not already exist. If this and parent_folder_id are sent an error will be returned. If neither is given, a default folder will be used.Output
Create a group
Create a group
CANVAS_CREATE_GROUPTool to create a new community group directly. Use when you need to create a group without specifying a group category. Groups created using this endpoint will be community groups.Input Parameters
Output
Create a group category in a course
Create a group category in a course
CANVAS_CREATE_GROUP_CATEGORY_COURSESCreates a group category in a specified Canvas course. It can also create groups in the category or distribute students among newly created groups.Input Parameters
Output
Create a content migration for group
Create a content migration for group
CANVAS_CREATE_GROUP_CONTENT_MIGRATIONTool to create a content migration in a Canvas group. Use when you need to import content into a group from various sources. If the migration requires a file upload, the actual processing starts once the file upload completes.Input Parameters
Output
Create group discussion topic
Create group discussion topic
CANVAS_CREATE_GROUP_DISCUSSION_TOPICTool to create a new discussion topic in a Canvas group. Use when creating a discussion for group collaboration or communication.Input Parameters
Output
Create group in set
Create group in set
Create a group set
Create a group set
Create Learning Outcome
Create Learning Outcome
CANVAS_CREATE_LEARNING_OUTCOMETool to create a new learning outcome in Canvas using GraphQL. Use when you need to define a new learning objective or competency within an outcome group.Input Parameters
Output
Create/Link an outcome in course
Create/Link an outcome in course
CANVAS_CREATE_LINK_OUTCOME_COURSESTool to link an existing outcome or create a new outcome within a course outcome group. Use when associating outcomes with outcome groups in a Canvas course context. If outcome_id is provided, links the existing outcome; otherwise creates a new outcome with the provided details (title, description, ratings, mastery_points).Input Parameters
Output
Create an LTI resource link
Create an LTI resource link
CANVAS_CREATE_LTI_RESOURCE_LINKCreates a new LTI Resource Link in a Canvas course. Use when integrating LTI 1.3 external tools that can be launched or embedded in rich content.Input Parameters
Output
Create a membership
Create a membership
CANVAS_CREATE_MEMBERSHIPCreates or requests individual or bulk membership in a Canvas group, depending on its join level. An empty successful response is represented by a synthetic accepted membership record rather than individual membership details.Input Parameters
Output
Create Module
Create Module
Create module (GraphQL)
Create module (GraphQL)
Create Module Item
Create Module Item
CANVAS_CREATE_MODULE_ITEMCreate and return a new module item within a Canvas course module. Use when you need to add content (assignments, pages, quizzes, files, discussions, external links, or subheaders) to an existing module.Input Parameters
Output
Create or Update Timetable Events
Create or Update Timetable Events
CANVAS_CREATE_OR_UPDATE_TIMETABLE_EVENTSTool to create or update timetable events for a course or course section. Use when you need to set up a complete schedule of events directly, rather than generating them from a timetable pattern. If a code is provided for an event, existing events with that code will be updated; otherwise, new events are created.Input Parameters
Output
Create a page for a course
Create a page for a course
CANVAS_CREATE_PAGE_FOR_COURSECreates a new wiki page in a specified Canvas course, with options for title, HTML body, editing permissions, publication, and designation as front page (which also requires publication).Input Parameters
Output
Create a page for a group
Create a page for a group
CANVAS_CREATE_PAGE_FOR_GROUPCreates a new wiki page in a specified Canvas group. Use when you need to create documentation, notes, or collaborative content for a group.Input Parameters
Output
Create a planner note
Create a planner note
CANVAS_CREATE_PLANNER_NOTECreate a planner note for the current user. Use when adding a personal to-do item or reminder to the Canvas planner.Input Parameters
Output
Create a planner override
Create a planner override
CANVAS_CREATE_PLANNER_OVERRIDETool to create a planner override for the current user. Use when marking planner items as complete or dismissing them from the opportunities list.Input Parameters
Output
Create Question Group
Create Question Group
CANVAS_CREATE_QUESTION_GROUPTool to create one or more question groups for a quiz. Use when you need to organize quiz questions into groups for random selection.Input Parameters
Output
Create Quiz
Create Quiz
CANVAS_CREATE_QUIZCreates a new quiz with various settings in a specified existing Canvas course; assignment_group_id applies only to graded quiz types.Input Parameters
one_question_at_a_time is also true, students cannot return to previous questions after submitting an answer for the current question. Default is false.hide_results is also set (not null), students can only view their results once, immediately after submitting the quiz. Has no effect if hide_results is null. Default is false.show_correct_answers_at and hide_correct_answers_at). Default is typically true.show_correct_answers to be true.show_correct_answers to be true.show_correct_answers to be true.Output
Create a quiz question
Create a quiz question
CANVAS_CREATE_QUIZ_QUESTIONCreates a new question for an existing quiz within a course; if answers are provided, their structure must align with question_type, and any quiz_group_id must be valid for an existing group in the quiz.Input Parameters
question_type. For multiple_choice/multiple_answers/true_false, use answer_text, answer_weight, and optional answer_comments (supports HTML). For matching, use answer_match_left, answer_match_right, and optional matching_answer_incorrect_matches (newline-delimited). For numerical, set numerical_answer_type to one of exact_answer, range_answer, or precision_answer with the corresponding numeric fields. For fill_in_multiple_blanks/multiple_dropdowns, include blank_id to associate answers with specific blanks.QuestionType enum.Output
Create Quiz Report
Create Quiz Report
CANVAS_CREATE_QUIZ_REPORTTool to create a quiz report in Canvas. Generates either a student analysis or item analysis report for a quiz. If a matching report already exists and is current, it will be returned instead.Input Parameters
Output
Create quiz submission (start quiz)
Create quiz submission (start quiz)
CANVAS_CREATE_QUIZ_SUBMISSIONTool to start taking a quiz by creating a quiz submission. Use when a student needs to begin a quiz-taking session. Returns the quiz submission with workflow_state indicating the session status (e.g., ‘preview’ for teacher previews).Input Parameters
Output
Create Rubric
Create Rubric
Create Single Poll
Create Single Poll
CANVAS_CREATE_SINGLE_POLLTool to create a new poll for the current user in Canvas. Use when you need to create a poll with a question and optional description.Input Parameters
Output
Create a single poll choice
Create a single poll choice
Create Single Poll Session
Create Single Poll Session
Create a single poll submission
Create a single poll submission
CANVAS_CREATE_SINGLE_POLL_SUBMISSIONTool to create a new poll submission for a poll session. Use when submitting a user’s choice(s) for an active poll. The poll session must be published before submissions can be created.Input Parameters
Output
Create Subgroup in Course
Create Subgroup in Course
CANVAS_CREATE_SUBGROUP_COURSESCreates a new empty subgroup under the outcome group with the given title and description. Use when you need to add a new subgroup to organize outcomes within a course’s outcome group hierarchy.Input Parameters
Output
Create submission draft
Create submission draft
CANVAS_CREATE_SUBMISSION_DRAFTTool to create a draft submission for an assignment in Canvas via GraphQL. Use when a student needs to save work in progress before final submission, or when pre-populating submission content.Input Parameters
Output
Create user inbox label
Create user inbox label
Create Users Custom Data
Create Users Custom Data
CANVAS_CREATE_USERS_CUSTOM_DATACreates or replaces a user’s custom JSON data at the root of a specified namespace. The namespace is required.Input Parameters
Output
Create User Token
Create User Token
CANVAS_CREATE_USERS_TOKENSTool to create a new access token for a Canvas user. Use when you need to generate an API access token for authentication purposes.Input Parameters
Output
Delete an access token
Delete an access token
CANVAS_DELETE_ACCESS_TOKENTool to delete an access token for a Canvas user. Use when you need to revoke or remove an API access token. The ID can be the actual database ID of the token, or the ‘token_hint’ value.Input Parameters
Output
Delete messages from conversation
Delete messages from conversation
CANVAS_DELETE_A_MESSAGETool to delete messages from a Canvas conversation. Note that this only affects this user’s view of the conversation. If all messages are deleted, the conversation will be removed as well.Input Parameters
Output
Delete a discussion entry
Delete a discussion entry
CANVAS_DELETE_AN_ENTRYDeletes an entry from a Canvas course discussion. The entry must have been created by the current user, or the current user must have admin rights to the discussion.Input Parameters
Output
Delete a group discussion entry
Delete a group discussion entry
CANVAS_DELETE_AN_ENTRY2Tool to delete a discussion entry in a group discussion. The entry must have been created by the current user, or the current user must have admin rights to the discussion. Use when removing an entry from a group discussion topic. The entry will be marked deleted, and user_id and message will be cleared.Input Parameters
Output
Delete an external tool
Delete an external tool
Delete an outcome group (courses)
Delete an outcome group (courses)
CANVAS_DELETE_AN_OUTCOME_GROUP_COURSESDeletes an outcome group from a course. Deleting an outcome group also deletes all descendant outcome groups and outcome links. Linked outcomes are only deleted if all links to the outcome were deleted. Aligned outcomes cannot be deleted; if all remaining links to an aligned outcome are in this group’s descendants, the deletion will fail.Input Parameters
Output
Delete appointment group
Delete appointment group
Delete an assignment
Delete an assignment
Delete assignment override
Delete assignment override
Delete blackout date
Delete blackout date
Delete bookmark
Delete bookmark
Delete a calendar event
Delete a calendar event
Delete comment bank item
Delete comment bank item
CANVAS_DELETE_COMMENT_BANK_ITEMTool to delete a comment bank item from Canvas. Use when you need to remove a previously saved grading comment that is no longer needed.Input Parameters
Output
Delete a communication channel
Delete a communication channel
CANVAS_DELETE_COMMUNICATION_CHANNELDeletes an existing communication channel for a user. Use when you need to remove an email, SMS, or push notification channel from a user’s account.Input Parameters
Output
Delete communication channel by type and address
Delete communication channel by type and address
CANVAS_DELETE_COMMUNICATION_CHANNEL_BY_TYPE_AND_ADDRESSDeletes a communication channel by type and address. Use when you need to remove a specific email, SMS, or push notification channel from a user’s account using the channel type and address instead of the channel ID.Input Parameters
Output
Delete conversation messages
Delete conversation messages
CANVAS_DELETE_CONVERSATION_MESSAGESTool to delete specific messages from a Canvas conversation. Use when you need to remove one or more messages from a conversation thread by their message IDs.Input Parameters
Output
Delete conversations
Delete conversations
Delete custom data
Delete custom data
CANVAS_DELETE_CUSTOM_DATADeletes all custom user data in a specified namespace for a user.Input Parameters
Output
Delete a custom gradebook column
Delete a custom gradebook column
Delete custom grade status
Delete custom grade status
Delete discussion entry
Delete discussion entry
Delete discussion topic (GraphQL)
Delete discussion topic (GraphQL)
Delete external feed from group
Delete external feed from group
Delete file
Delete file
CANVAS_DELETE_FILETool to remove a file from Canvas. Use when comprehensive, irretrievable destruction of the file is needed. Set replace to true to destroy file previews and replace contents with a placeholder (requires special permissions).Input Parameters
Output
Delete a folder
Delete a folder
Delete a group
Delete a group
Delete group discussion topic
Delete group discussion topic
Delete outcome links
Delete outcome links
Delete page for a group
Delete page for a group
CANVAS_DELETE_PAGE_FOR_GROUPDeletes a wiki page from a Canvas group. Use when you need to remove a specific page from a group’s wiki.Input Parameters
Output
Delete a planner note
Delete a planner note
Delete a planner override
Delete a planner override
Delete poll
Delete poll
Delete a poll choice
Delete a poll choice
Delete a poll session
Delete a poll session
Delete quiz
Delete quiz
Delete submission draft
Delete submission draft
Delete user inbox label
Delete user inbox label
Delete user custom data scope
Delete user custom data scope
CANVAS_DELETE_USERS_CUSTOM_DATA_SCOPETool to delete custom user data at a specific scope path. Use when you need to remove data stored at a particular location within the JSON structure for a user’s custom data namespace.Input Parameters
Output
Get current grades
Get current grades
Get term grade data
Get term grade data
Post discussion entry or reply
Post discussion entry or reply
CANVAS_DRAFT_REPLY_TO_DISCUSSIONPosts a new entry or reply to a Canvas discussion topic. Creates either a top-level entry (when entry_id is omitted) or a nested reply to an existing entry (when entry_id is provided). The entry is posted immediately and becomes visible to discussion participants.Input Parameters
Output
Duplicate group discussion topic
Duplicate group discussion topic
Edit assignment
Edit assignment
CANVAS_EDIT_ASSIGNMENTUpdates an existing assignment in a Canvas course (identified by course_id and assignment_id); only attributes explicitly provided in the request are modified.Input Parameters
True to publish, False to unpublish. If not provided, the existing published status will be retained.Output
Edit a conversation
Edit a conversation
CANVAS_EDIT_CONVERSATIONTool to update attributes for a single conversation in Canvas. Use when you need to star/unstar, subscribe/unsubscribe, or change the workflow state (read, unread, archived) of a specific conversation.Input Parameters
Output
Edit a quiz
Edit a quiz
CANVAS_EDIT_QUIZModifies an existing Canvas quiz. Update notifications are requested by default and can be disabled.Input Parameters
one_question_at_a_time is true). If None, this setting will not be updated.allowed_attempts > 1). If None, this setting will not be updated.hide_results, show_correct_answers_at, hide_correct_answers_at). If None, this setting will not be updated.Output
Edit User
Edit User
Export content
Export content
CANVAS_EXPORT_CONTENTInitiates an asynchronous export of course content from Canvas. Returns an export job ID and progress URL that can be used to track the export status and retrieve the exported file once complete. Supports exporting full courses (Common Cartridge), quizzes (QTI), or files (ZIP).Input Parameters
Output
Export group content
Export group content
CANVAS_EXPORT_GROUP_CONTENTTool to begin a content export job for a group. Groups only support ZIP format exports of files and folders. Returns an export job with a progress_url to track the export status using the Progress API. Once complete, the exported file can be downloaded via the attachment URL.Input Parameters
Output
Export user content
Export user content
CANVAS_EXPORT_USER_CONTENTTool to begin a content export job for a user. Use when you need to export user content from Canvas in Common Cartridge, QTI, or ZIP format. Track progress using the Progress API via the progress_url returned in the response. Once complete, download the exported file via the attachment URL.Input Parameters
Output
Fetch Data
Fetch Data
CANVAS_FETCH_DATAFetches summarized IDs and names for one category of Canvas data, such as accounts, courses, or users, selected by exactly one get_* flag and any required IDs. Pagination applies to categories other than accounts, with per_page defaulting to 100 (maximum 100) and page to 1.Input Parameters
account_id is not provided, defaults to ‘self’ (current user’s account). Optionally filter users by search_term.get_users is true, defaults to the current user’s account. Can be found via get_accounts.enrollment_type and enrollment_state.course_id and assignment_id).user_id), optionally filtered by enrollment_type and enrollment_state.get_discussion_topics is true: if true, retrieves only announcements; if false, retrieves only discussion topics; if not specified, retrieves discussion topics (defaults to false).course_id). Use only_announcements to control whether to fetch announcements only (true), discussion topics only (false), or use default behavior (None). Can be filtered by search_term.Output
Find recipients
Find recipients
CANVAS_FIND_RECIPIENTSFind valid recipients (users, courses and groups) that the current user can send messages to. Use when searching for message recipients or looking up specific users/contexts by id.Input Parameters
Output
Get a single course from account
Get a single course from account
CANVAS_GET_ACCOUNT_COURSETool to retrieve information on a single course from a Canvas account. Use when you need to get detailed course information including optional data like teachers, term, permissions, or course progress.Input Parameters
Output
Get account (GraphQL)
Get account (GraphQL)
Get Account Notifications
Get Account Notifications
CANVAS_GET_ACCOUNT_NOTIFICATIONSTool to retrieve global account notifications for the current user in Canvas LMS. Use when you need to check announcements, alerts, or system-wide messages that admins have posted to the account.Input Parameters
Output
Get accounts outcome groups
Get accounts outcome groups
Get Accounts That Users Can Create Courses In
Get Accounts That Users Can Create Courses In
Get a content migration for group
Get a content migration for group
Get a content migration for user
Get a content migration for user
Get a late policy
Get a late policy
Get aligned assignments for an outcome
Get aligned assignments for an outcome
CANVAS_GET_ALIGNED_ASSIGNMENTS_FOR_AN_OUTCOMERetrieves outcome alignments for a student or assignment within a course. Use when you need to see which assignments are aligned to learning outcomes, optionally filtered by student or assignment.Input Parameters
Output
Get assignments for a specific course (requires course_id)
Get assignments for a specific course (requires course_id)
CANVAS_GET_ALL_ASSIGNMENTSRetrieves assignments for a specific Canvas course. IMPORTANT: This action requires a course_id parameter - it does NOT retrieve assignments globally across all courses. You must first obtain a valid course_id (e.g., from CANVAS_LIST_COURSES) and provide it to retrieve that course’s assignments. Results may be nested under a response_data array; inspect the JSON structure before iterating. due_at values are ISO 8601 strings in UTC. Filter on published, locked_for_user, and has_submitted_submissions fields to identify actionable assignments.Input Parameters
Output
Get All ePortfolios for User
Get All ePortfolios for User
CANVAS_GET_ALL_E_PORTFOLIOS_FOR_USERLists ePortfolios for a specified Canvas user, paginated. Deleted ePortfolios can be included where permitted.Input Parameters
Output
Get All Outcome Groups for Context
Get All Outcome Groups for Context
CANVAS_GET_ALL_OUTCOME_GROUPS_FOR_CONTEXTRetrieves a page of learning outcome groups for a Canvas account context, with a next-page token when available.Input Parameters
Output
Get all outcome groups for course
Get all outcome groups for course
CANVAS_GET_ALL_OUTCOME_GROUPS_FOR_CONTEXT2Retrieves a page of learning outcome groups for a specific Canvas course, with a next-page token when available.Input Parameters
Output
Get All Outcome Links for Context
Get All Outcome Links for Context
CANVAS_GET_ALL_OUTCOME_LINKS_FOR_CONTEXTRetrieves a page of outcome links for a Canvas account, representing relationships between outcomes and outcome groups. Returns a next-page token when available.Input Parameters
Output
Get All Outcome Links for Context (Courses)
Get All Outcome Links for Context (Courses)
CANVAS_GET_ALL_OUTCOME_LINKS_FOR_CONTEXT2Retrieves a page of outcome links for a Canvas course, representing relationships between outcomes and outcome groups. Returns a next-page token when available.Input Parameters
Output
Get all peer reviews for submission
Get all peer reviews for submission
CANVAS_GET_ALL_PEER_REVIEWSRetrieves a page of peer reviews for a specific submission within a Canvas assignment, with a next-page token when available.Input Parameters
Output
Get all peer reviews for section assignment
Get all peer reviews for section assignment
CANVAS_GET_ALL_PEER_REVIEWS_FOR_SECTION_ASSIGNMENTRetrieves a page of peer reviews for a specific assignment within a Canvas section, with a next-page token when available.Input Parameters
Output
Get all peer reviews for section submission
Get all peer reviews for section submission
CANVAS_GET_ALL_PEER_REVIEWS_FOR_SECTION_SUBMISSIONRetrieves a page of peer reviews for a specific submission within a Canvas section assignment, with a next-page token when available.Input Parameters
Output
Get all users
Get all users
Get an assignment group
Get an assignment group
CANVAS_GET_AN_ASSIGNMENT_GROUPRetrieves the assignment group with the given id from a Canvas course. Use when you need to get details about a specific assignment group, including its name, position, weight, and optionally associated assignments.Input Parameters
Output
Get notification preference
Get notification preference
Get notification preference by type and address
Get notification preference by type and address
CANVAS_GET_A_PREFERENCE_BY_TYPE_AND_ADDRESSFetches the notification preference for a specific notification on a given communication channel using channel type and address. Use when you need to check how often a user receives notifications for a particular event type on a specific communication channel.Input Parameters
Output
Get a single external tool
Get a single external tool
Get a single group membership
Get a single group membership
Get a single group membership by user ID
Get a single group membership by user ID
Get assignment (GraphQL)
Get assignment (GraphQL)
Get assignment group
Get assignment group
Get Assignment Rubric
Get Assignment Rubric
Get Audit Logs
Get Audit Logs
CANVAS_GET_AUDIT_LOGSTool to access Canvas audit logs for a specified asset using the GraphQL API. Use when retrieving mutation logs to track changes and operations performed on accounts, courses, or users.Input Parameters
Output
Get a user's most recently graded submissions
Get a user's most recently graded submissions
CANVAS_GET_A_USERS_MOST_RECENTLY_GRADEDRetrieves a user’s most recently graded submissions. Use ‘self’ as the user ID to get graded submissions for the authenticated user.Input Parameters
Output
Get Authentication Provider
Get Authentication Provider
CANVAS_GET_AUTHENTICATION_PROVIDERRetrieves a specific authentication provider configuration for a Canvas account. Use when you need to view the configuration details of a specific authentication provider.Input Parameters
Output
Get Bookmark
Get Bookmark
Get brand variables
Get brand variables
Get course
Get course
CANVAS_GET_COURSETool to retrieve information about a specific course by ID using the Canvas GraphQL API. Use when querying course details with either GraphQL or numeric identifiers.Input Parameters
Output
Get course activity stream
Get course activity stream
Get course activity stream summary
Get course activity stream summary
CANVAS_GET_COURSE_ACTIVITY_STREAM_SUMMARYTool to retrieve a summary of the current user’s course-specific activity stream. Returns aggregated counts by activity type (discussions, conversations, messages, etc.) for the specified course. Use when you need an overview of activity in a specific course.Input Parameters
Output
Get Course Activity
Get Course Activity
Get course nickname
Get course nickname
Get Course Permissions
Get Course Permissions
CANVAS_GET_COURSE_PERMISSIONSReturns permission information for the calling user in the given course. Use when you need to check what actions the authenticated user is authorized to perform in a specific course.Input Parameters
Output
Batch retrieve assignment overrides
Batch retrieve assignment overrides
CANVAS_GET_COURSES12_ASSIGNMENTSBatch retrieves course assignment overrides using paired override and assignment IDs; unequal lists are truncated to the shorter length. Results can contain null entries for overrides that are missing or not visible to the current user.Input Parameters
Output
Get Blueprint Subscription Migrations
Get Blueprint Subscription Migrations
CANVAS_GET_COURSES_BLUEPRINT_SUBSCRIPTIONS_MIGRATIONSLists blueprint subscription migrations for an associated Canvas course, with pagination. A 403 or 404 response is returned as an empty list, so an empty result does not necessarily mean there are no migrations.Input Parameters
Output
Get course settings
Get course settings
Get courses folders by path
Get courses folders by path
CANVAS_GET_COURSES_FOLDERS_BY_PATHTool to retrieve folder hierarchy by resolving a path within a Canvas course. Use when you need to traverse a folder path or verify a folder exists at a specific location.Input Parameters
Output
Get course root folder
Get course root folder
Get courses (GraphQL)
Get courses (GraphQL)
CANVAS_GET_COURSES_GRAPH_QLTool to get all courses viewable by the current user using the Canvas GraphQL API. Use when retrieving the list of courses accessible to the authenticated user.Input Parameters
Output
Get courses outcome groups
Get courses outcome groups
Get Current User
Get Current User
Get Custom Color
Get Custom Color
CANVAS_GET_CUSTOM_COLORTool to retrieve the custom color that a user has saved for a specific course or context in Canvas. Use when you need to fetch user-specific color preferences for a course or other context.Input Parameters
Output
Get Custom Colors
Get Custom Colors
CANVAS_GET_CUSTOM_COLORSTool to retrieve all custom colors saved by a user in Canvas LMS. Use when you need to fetch color customizations for courses or other Canvas objects.Input Parameters
Output
Get Dashboard Positions
Get Dashboard Positions
Get department-level completed statistics
Get department-level completed statistics
CANVAS_GET_DEPARTMENT_LEVEL_COMPLETED_STATISTICSRetrieves department-level statistics for completed courses in the default term of a specified Canvas account. The statistics include aggregate counts of courses, subaccounts, enrollments, discussion topics, media objects, attachments, and assignments.Input Parameters
Output
Get department level current statistics
Get department level current statistics
Get department level completed grades
Get department level completed grades
CANVAS_GET_DEPARTMENT_LEVEL_GRADE_DATA_COMPLETED_GRADESRetrieves the distribution of final grades for completed courses in a Canvas account. Grades are grouped into whole-number bins from 0 to 100, with each data point representing one student’s final grade in one course.Input Parameters
Output
Get department level term statistics
Get department level term statistics
CANVAS_GET_DEPARTMENT_LEVEL_TERM_STATISTICSRetrieves department-level statistics for a specific academic term, including counts of courses, teachers, students, discussion topics, media objects, attachments, and assignments. Requires the Canvas Analytics feature to be enabled.Input Parameters
Output
Get document annotations read state
Get document annotations read state
CANVAS_GET_DOCUMENT_ANNOTATIONS_READ_STATERetrieves the read state of document annotations for a student’s submission. Use when checking if a student has viewed feedback annotations on their submitted document.Input Parameters
Output
Get enrollment by ID
Get enrollment by ID
CANVAS_GET_ENROLLMENT_BY_IDRetrieves a specific enrollment by its ID within a given Canvas account. Returned enrollment details may include grades and SIS information when available and permitted.Input Parameters
Output
Get Enrollment Invitations
Get Enrollment Invitations
CANVAS_GET_ENROLLMENT_INVITATIONSRetrieves a page of the current user’s enrollments, defaulting to pending invitations. Other enrollment states can be selected.Input Parameters
Output
Get feature flag for account
Get feature flag for account
CANVAS_GET_FEATURE_FLAGTool to retrieve a specific feature flag for a given Canvas account. The flag may be defined on the account, or it may be inherited from a parent account. Check context_id and context_type fields to determine the source; if these fields are missing, the flag represents the global Canvas default.Input Parameters
Output
Get feature flag for course
Get feature flag for course
CANVAS_GET_FEATURE_FLAG_COURSESGet the feature flag that applies to a given Course. The flag may be defined on the course, or it may be inherited from a parent account. Check the context_id and context_type of the returned object to determine which is the case.Input Parameters
Output
Get file
Get file
CANVAS_GET_FILETool to retrieve detailed metadata for a specific Canvas file by its ID. Use when you need information about a single file including its name, size, content type, URLs, and optionally the user who uploaded it.Input Parameters
Output
Get folder
Get folder
Get Folder By ID
Get Folder By ID
Get Full Topic for Groups
Get Full Topic for Groups
CANVAS_GET_FULL_TOPIC_GROUPSTool to retrieve the full cached structure of a group discussion topic. Use when you need all entries, their authors, and message bodies in a hierarchical format. Note: May require that the user has posted in the topic; if required and the user has not posted, will respond with 403 Forbidden.Input Parameters
Output
Get Global Outcome Group
Get Global Outcome Group
Get gradebook history days
Get gradebook history days
Get a group
Get a group
CANVAS_GET_GROUPRetrieves detailed information for a single Canvas group by its ID. Use when you need to get information about a specific group including optional permissions and tab configurations.Input Parameters
Output
Get group activity stream
Get group activity stream
Get Group Activity Stream Summary
Get Group Activity Stream Summary
Get Group Folder
Get Group Folder
Get Group Permissions
Get Group Permissions
CANVAS_GET_GROUP_PERMISSIONSReturns permission information for the calling user in the given group. Use when you need to check what actions the authenticated user is authorized to perform in a specific group.Input Parameters
Output
Get account help links
Get account help links
CANVAS_GET_HELP_LINKSRetrieves help links configured for the specified Canvas account. Use when you need to access help resources available to users in an account.Input Parameters
Output
Get Internal Settings
Get Internal Settings
Get Kaltura config
Get Kaltura config
Get learning outcome
Get learning outcome
CANVAS_GET_LEARNING_OUTCOMETool to retrieve learning outcome information by ID using the Canvas GraphQL API. Use when you need to fetch details about a specific learning outcome including its title and description.Input Parameters
Output
Get learning outcome group
Get learning outcome group
CANVAS_GET_LEARNING_OUTCOME_GROUPTool to retrieve learning outcome group information by ID via GraphQL. Use when you need to fetch details about a specific learning outcome group including its title and description.Input Parameters
Output
Get Legacy Node
Get Legacy Node
CANVAS_GET_LEGACY_NODEFetch a supported Canvas object by type and REST-style numeric ID via GraphQL. By default, returns only the type name and legacy ID; additional fields can be requested using a GraphQL fragment.Input Parameters
Output
Get manually-created courses sub-account
Get manually-created courses sub-account
Get Module Item
Get Module Item
Get Module Item Sequence
Get Module Item Sequence
Get my inbox settings
Get my inbox settings
Get next appointment
Get next appointment
CANVAS_GET_NEXT_APPOINTMENTRetrieves the next available appointment from Canvas appointment groups. Returns a single-element array if an appointment is available, or an empty array if none are available.Input Parameters
Output
Get node by ID
Get node by ID
CANVAS_GET_NODEFetches a Canvas object by its GraphQL global identifier using the node query. By default, returns its type and ID; an optional GraphQL fragment can request additional fields.Input Parameters
Output
Get outcome calculation method
Get outcome calculation method
CANVAS_GET_OUTCOME_CALCULATION_METHODTool to retrieve outcome calculation method information by ID using the Canvas GraphQL API. Use when you need to fetch details about how outcomes are calculated for assessments.Input Parameters
Output
Get outcome proficiency (GraphQL)
Get outcome proficiency (GraphQL)
Get outcome result rollups
Get outcome result rollups
CANVAS_GET_OUTCOME_RESULT_ROLLUPSRetrieves outcome result rollups for users and outcomes in a course, including optional course aggregates. List-valued rollup scores are returned as null by the response model.Input Parameters
Output
Get Outcome Results
Get Outcome Results
CANVAS_GET_OUTCOME_RESULTSTool to get outcome results for users and outcomes in a course context. Use when you need to retrieve learning outcome assessment results for students.Input Parameters
Output
Get Page for a Course
Get Page for a Course
CANVAS_GET_PAGE_FOR_COURSERetrieves a specific content page (wiki or content page) by its URL or numeric ID from a specified Canvas course.Input Parameters
Output
Get proficiency ratings for course
Get proficiency ratings for course
CANVAS_GET_PROFICIENCY_RATINGS_FOR_COURSERetrieves course-level proficiency ratings for learning outcomes. If not defined for the requested course, it will return proficiency ratings from the account or nearest super-account with ratings defined. Use when you need to view the performance level definitions used for grading outcomes in a specific course.Input Parameters
Output
Get public inline preview URL
Get public inline preview URL
CANVAS_GET_PUBLIC_INLINE_PREVIEW_URLTool to determine the URL for inline preview of a Canvas file. Use when you need to access the public URL of a file.Input Parameters
Output
Get a quiz report
Get a quiz report
CANVAS_GET_QUIZ_REPORTRetrieves data for a single quiz report, including available status and report file information for a previously generated report.Input Parameters
Output
Get Quiz Statistics
Get Quiz Statistics
CANVAS_GET_QUIZ_STATISTICSTool to fetch the latest quiz statistics for a Canvas quiz. Use when you need statistical data about quiz submissions, including per-question metrics and aggregate submission statistics.Input Parameters
Output
Get quiz submissions
Get quiz submissions
CANVAS_GET_QUIZ_SUBMISSIONSRetrieves a page of submissions for a specific quiz within a course, with a next-page token when available.Input Parameters
Output
Get Quota Information
Get Quota Information
CANVAS_GET_QUOTA_INFORMATIONRetrieves the total and used storage quota for a Canvas user. Use when you need to check storage space availability or usage.Input Parameters
Output
Get quota information for group
Get quota information for group
Get report status
Get report status
Get Root Outcome Group for Course
Get Root Outcome Group for Course
Get rubric
Get rubric
CANVAS_GET_RUBRICTool to retrieve rubric information by ID using the Canvas GraphQL API. Use when you need to fetch detailed rubric data including criteria, points, and configuration settings.Input Parameters
Output
Get Rubric Assessments Read State
Get Rubric Assessments Read State
CANVAS_GET_RUBRIC_ASSESSMENTS_READ_STATETool to check whether new rubric comments/grading made on a submission have been seen by the student being assessed. Use when you need to verify if a student has reviewed their rubric feedback.Input Parameters
Output
Get Rubrics Upload Template
Get Rubrics Upload Template
Get running batches
Get running batches
Get section information
Get section information
CANVAS_GET_SECTION_INFORMATIONRetrieves detailed information for a specific Canvas section within a course. Use when you need section details including optional student lists, enrollment data, or permissions.Input Parameters
Output
Get section information by ID
Get section information by ID
CANVAS_GET_SECTION_INFORMATION2Retrieves detailed information for a specific Canvas section by section ID alone. Use when you have the section ID but not the course ID, or when you need section details with optional student lists, enrollment data, or permissions.Input Parameters
Output
Get section assignment submission summary
Get section assignment submission summary
CANVAS_GET_SECTION_SUBMISSION_SUMMARYRetrieves submission summary counts for a specific assignment within a section. Returns the number of submissions categorized as graded, ungraded, and not submitted based on gradeable students in the section.Input Parameters
Output
Get sessionless launch URL for external tool
Get sessionless launch URL for external tool
CANVAS_GET_SESSIONLESS_LAUNCH_URLReturns a sessionless launch URL for an external tool in a Canvas account. Prefers the resource link lookup UUID, with ID, URL, or launch type as alternatives.Input Parameters
Output
Get sessionless launch URL for external tool in course
Get sessionless launch URL for external tool in course
CANVAS_GET_SESSIONLESS_LAUNCH_URL_FOR_COURSEReturns a sessionless launch URL for an external tool in a Canvas course. Prefers the resource_link_lookup_uuid parameter, but defaults to id, url, or launch_type if not provided. Use when you need to generate a launch URL for an external tool in a specific course without requiring a user session.Input Parameters
Output
Get a single account
Get a single account
CANVAS_GET_SINGLE_ACCOUNTRetrieve information on an individual account by ID or SIS account ID. Use when you need detailed account information for a specific account.Input Parameters
Output
Get a single assignment override
Get a single assignment override
Get single calendar event
Get single calendar event
Get a single conversation
Get a single conversation
CANVAS_GET_SINGLE_CONVERSATIONRetrieve a Canvas conversation with messages and extended participant information. Retrieving it may mark an unread conversation as read; automatic marking can be controlled in the request.Input Parameters
Output
Get a single course
Get a single course
CANVAS_GET_SINGLE_COURSERetrieves detailed information for a specific Canvas course using its course_id, which must be valid, and allows for including additional data fields in the response via the include parameter. Concluded or unpublished courses may have restricted visibility depending on the caller’s role; include ‘concluded’ in include to retrieve richer metadata for such courses.Input Parameters
include, limits the number of teacher enrollments returned; API default applies otherwise.Output
Get a single external tool
Get a single external tool
Get a single grading standard in course context
Get a single grading standard in course context
Get a single poll
Get a single poll
Get a single poll choice
Get a single poll choice
Get a single quiz
Get a single quiz
Get single quiz submission
Get single quiz submission
CANVAS_GET_SINGLE_QUIZ_SUBMISSIONTool to retrieve a single quiz submission by ID. Use when you need details about a specific student’s quiz attempt. Returns submission status, score, timing, and optionally related assignment, quiz, or user data.Input Parameters
Output
Get single submission
Get single submission
CANVAS_GET_SINGLE_SUBMISSIONRetrieves a specific submission for an assignment made by a particular user within a designated course.Input Parameters
Output
Get single submission by section
Get single submission by section
CANVAS_GET_SINGLE_SUBMISSION_BY_SECTIONRetrieves a specific submission for an assignment made by a particular user within a designated section. Use when you have section_id instead of course_id.Input Parameters
Output
Get a single discussion topic
Get a single discussion topic
CANVAS_GET_SINGLE_TOPICTool to retrieve detailed information about a single discussion topic in a Canvas course. Use when you need to fetch data for a specific discussion topic by its ID.Input Parameters
Output
Get a single group discussion topic
Get a single group discussion topic
CANVAS_GET_SINGLE_TOPIC2Tool to retrieve detailed information about a single discussion topic within a Canvas group. Use when you need to fetch data for a specific discussion topic by its ID from a group context.Input Parameters
Output
Get Single User
Get Single User
CANVAS_GET_SINGLE_USERRetrieves detailed information for a single user in a Canvas course. Accepts the same include[] parameters as the list users endpoint and returns a single user with the same fields.Input Parameters
Output
Get Status of Last Report
Get Status of Last Report
CANVAS_GET_STATUS_OF_LAST_REPORTTool to retrieve the status of the last generated report for a specific course in Canvas. Use when you need to check the completion status, download URL, or progress of a course report.Input Parameters
Output
Get sub-accounts of an account
Get sub-accounts of an account
CANVAS_GET_SUB_ACCOUNTSLists sub-accounts of a Canvas account, with optional recursive retrieval. Results are returned one page at a time.Input Parameters
Output
Get submission
Get submission
CANVAS_GET_SUBMISSIONTool to retrieve submission information by ID using the Canvas GraphQL API. Use when you need to fetch submission details including state, attempt number, and associated user/assignment data.Input Parameters
Output
Get assignment submission summary
Get assignment submission summary
CANVAS_GET_SUBMISSION_SUMMARYRetrieves submission summary counts for a specific assignment. Returns the number of submissions categorized as graded, ungraded, and not submitted based on gradeable students.Input Parameters
Output
Get terms of service
Get terms of service
Get quiz submission
Get quiz submission
CANVAS_GET_THE_QUIZ_SUBMISSIONTool to get the quiz submission for the current user in a specific quiz. Use when you need to retrieve submission details for the authenticated user.Input Parameters
Output
Get Unread Count
Get Unread Count
Get uploaded media folder for user
Get uploaded media folder for user
Get uploaded media folder for user (groups)
Get uploaded media folder for user (groups)
CANVAS_GET_UPLOADED_MEDIA_FOLDER_FOR_USER_GROUPSTool to retrieve the details for a designated upload folder that the user has rights to upload media to within a group, creating it if it doesn’t exist. Use when you need to access or manage the media upload folder for a specific group.Input Parameters
Output
Get user activity stream summary
Get user activity stream summary
CANVAS_GET_USER_ACTIVITY_STREAM_SUMMARYTool to retrieve a summary of the current user’s global activity stream. Returns aggregated counts by activity type (discussions, conversations, messages, etc.) across all courses. Use when you need an overview of the user’s activity across their entire Canvas account.Input Parameters
Output
Get user assignment analytics
Get user assignment analytics
Get User Avatars
Get User Avatars
Get user content export
Get user content export
CANVAS_GET_USER_CONTENT_EXPORTTool to retrieve information about a specific content export job for a user. Use when you need to check the status of a user’s export and get the download URL when the export completes.Input Parameters
Output
Get user course progress
Get user course progress
CANVAS_GET_USER_COURSE_PROGRESSRetrieves a user’s progress in a Canvas course, including module requirement counts and completion details. Use ‘self’ as the user ID to retrieve progress for the authenticated user.Input Parameters
Output
Get user file
Get user file
CANVAS_GET_USER_FILETool to retrieve detailed metadata for a specific file owned by a user. Use when you need information about a file in a user’s context, including its name, size, content type, URLs, and optionally the user who uploaded it.Input Parameters
Output
Get user folder
Get user folder
CANVAS_GET_USER_FOLDERTool to retrieve details for a specific folder in a user’s Canvas file space. Use ‘root’ as the folder ID to get the root folder, or ‘self’ as user_id for the current authenticated user.Input Parameters
Output
Get user migration issue
Get user migration issue
CANVAS_GET_USER_MIGRATION_ISSUETool to retrieve detailed information about a specific migration issue for a user in Canvas. Use when you need to investigate issues that occurred during a user’s content migration process.Input Parameters
Output
Get user participation analytics
Get user participation analytics
Get User Profile
Get User Profile
Get Users Custom Data Scope
Get Users Custom Data Scope
CANVAS_GET_USERS_CUSTOM_DATA_SCOPETool to retrieve custom data stored for a Canvas user within a specified namespace and optional scope. Use when you need to fetch application-specific data that was previously stored for a user. The namespace parameter (ns) is required to prevent data collisions between different applications.Input Parameters
Output
Get users self files
Get users self files
CANVAS_GET_USERS_SELF_FILESLists a page of files in the authenticated user’s personal file storage. Supports filtering by content type, searching by filename, sorting, and requesting a page.Input Parameters
Output
Get User Token
Get User Token
CANVAS_GET_USERS_TOKENSRetrieves detailed information about a specific access token for a Canvas user. Use when you need to inspect token properties like expiration, scopes, or workflow state.Input Parameters
Output
Grade or comment on a submission
Grade or comment on a submission
CANVAS_GRADE_COMMENT_SUBMISSIONUpdates a student’s assignment submission with a grade, comment, sticker, or status change; requires course_id, assignment_id, user_id, and at least one update field. Rubric assessments are not supported and require a separate Canvas API call.Input Parameters
late_policy_status or for manual adjustment.Output
Grade or comment on submission (sections)
Grade or comment on submission (sections)
CANVAS_GRADE_OR_COMMENT_ON_SUBMISSION_SECTIONSUpdate grades and/or add comments to a student’s assignment submission. Use when you need to provide feedback or scoring. Requires permission to manage grades when updating grades or rubric assessments.Input Parameters
Output
Hide all stream items
Hide all stream items
Hide assignment grades for sections
Hide assignment grades for sections
CANVAS_HIDE_ASSIGNMENT_GRADES_FOR_SECTIONSTool to hide assignment grades for specific sections in Canvas. Use when you need to conceal grades from students in particular course sections, typically during grading periods or before releasing final grades.Input Parameters
Output
Hide stream item
Hide stream item
Import an outcome group (courses)
Import an outcome group (courses)
CANVAS_IMPORT_OUTCOME_GROUP_COURSESTool to import an outcome group into a Canvas course. Creates a new subgroup with the same title and description as the source, then creates links to the same outcomes and recursively imports subgroups. Use when duplicating outcome groups within or across courses. Set async=true for large imports to track progress.Input Parameters
Output
Invite others to a group
Invite others to a group
CANVAS_INVITE_OTHERS_TO_GROUPTool to send invitations to all supplied email addresses which will allow the receivers to join the group. Use when you need to add new members to a Canvas group via email invitation.Input Parameters
Output
Leave a group
Leave a group
CANVAS_LEAVE_GROUPTool to leave a group by removing the specified membership. Use when you need to remove a user from a group they are allowed to leave. Note: Some groups, such as sets of course groups created by teachers, cannot be left.Input Parameters
Output
Leave group
Leave group
CANVAS_LEAVE_GROUP2Tool to leave a group if allowed. Use when a user needs to exit a group membership. Note that some groups, such as course groups created by teachers, cannot be left by members.Input Parameters
Output
List account notifications
List account notifications
CANVAS_LIST_ACCOUNT_NOTIFICATIONSLists global notifications for a Canvas account, paginated. It can include past notifications or, for account admins, all announcements regardless of role or availability date.Input Parameters
Output
List Accounts for Course Admins
List Accounts for Course Admins
CANVAS_LIST_ACCOUNTS_FOR_COURSE_ADMINSRetrieves Canvas accounts visible to the current user due to their course-level administrative roles; no request parameters are needed.Input Parameters
Output
List the activity stream
List the activity stream
CANVAS_LIST_ACTIVITY_STREAMRetrieves the current user’s global activity stream from Canvas, paginated. Returns recent activities across courses including discussions, conversations, messages, submissions, conferences, and announcements. Use to display user’s recent Canvas activity or notifications.Input Parameters
Output
List all courses (GraphQL)
List all courses (GraphQL)
List all folders
List all folders
CANVAS_LIST_ALL_FOLDERSRetrieves the paginated list of all folders for a specified Canvas course. Returns a flat list containing the root folder and all nested subfolders. This action is scoped to courses only.Input Parameters
Output
List all folders for group
List all folders for group
CANVAS_LIST_ALL_FOLDERS_GROUPSRetrieves a paginated, flat list of folders for a specified Canvas group, including nested subfolders. Use the returned next-page token to retrieve further pages.Input Parameters
Output
List all folders for user
List all folders for user
CANVAS_LIST_ALL_FOLDERS_USERSTool to retrieve the paginated list of all folders for a specified Canvas user. Returns a flat list containing the root folder and all nested subfolders. Use when you need to access or browse a user’s folder structure.Input Parameters
Output
List Announcements
List Announcements
CANVAS_LIST_ANNOUNCEMENTSTool to retrieve paginated list of announcements for specified courses and date range. Use when you need to fetch course announcements with optional filtering by dates and inclusion of additional context.Input Parameters
Output
List appointment groups
List appointment groups
CANVAS_LIST_APPOINTMENT_GROUPSRetrieves a list of Canvas appointment groups based on specified filters; any provided context_codes must be valid and accessible by the user.Input Parameters
Output
List assignment groups
List assignment groups
CANVAS_LIST_ASSIGNMENT_GROUPSReturns the paginated list of assignment groups for the current context. Use when you need to retrieve assignment groups for a course. The returned groups are sorted by their position field.Input Parameters
Output
List assignment overrides
List assignment overrides
CANVAS_LIST_ASSIGNMENT_OVERRIDESTool to retrieve the paginated list of overrides for an assignment. Use when you need to see which sections, groups, or students have custom due dates or availability settings for a specific assignment.Input Parameters
Output
List assignments for assignment group
List assignments for assignment group
CANVAS_LIST_ASSIGNMENTS_FOR_ASSIGNMENT_GROUPTool to retrieve the paginated list of assignments for a specific assignment group within a course. Use when you need assignments grouped by assignment group rather than all assignments for a course.Input Parameters
Output
List assignments for user in course
List assignments for user in course
CANVAS_LIST_ASSIGNMENTS_FOR_USERTool to list assignments for a specific user in a Canvas course. Use when you need to retrieve assignments visible to a particular user, with optional filtering by due date, submission status, or search term. This endpoint respects user permissions and returns only assignments the specified user has rights to view.Input Parameters
Output
List assignment submissions
List assignment submissions
CANVAS_LIST_ASSIGNMENT_SUBMISSIONSRetrieves submissions for a specific assignment within a course, optionally including related resources or grouping by student group for group assignments. Supports pagination to retrieve more than the default 10 submissions.Input Parameters
Output
List assignment submissions by section
List assignment submissions by section
CANVAS_LIST_ASSIGNMENT_SUBMISSIONS_BY_SECTIONLists a page of submissions for an assignment within a specific section, with pagination for subsequent pages.Input Parameters
Output
List Authentication Events for User
List Authentication Events for User
CANVAS_LIST_AUTHENTICATION_EVENTS_FOR_USERTool to list authentication events (logins and logouts) for a given user from Canvas LMS audit logs. Use when you need to track user authentication activity or investigate login/logout history. Events are stored for one year and returned in descending chronological order.Input Parameters
Output
List available account calendars
List available account calendars
CANVAS_LIST_AVAILABLE_ACCOUNT_CALENDARSReturns a paginated list of account calendars available to the current user. Includes visible account calendars where the user has an account association.Input Parameters
Output
List Available Reports
List Available Reports
CANVAS_LIST_AVAILABLE_REPORTSLists available reports (including those that can be or have been generated) for a valid Canvas account ID.Input Parameters
Output
List Available Tabs for a Course
List Available Tabs for a Course
CANVAS_LIST_AVAILABLE_TABS_FOR_COURSETool to retrieve navigation tabs for a Canvas course. Use when you need to see available navigation options for a specific course.Input Parameters
Output
List Available Tabs for a Group
List Available Tabs for a Group
CANVAS_LIST_AVAILABLE_TABS_FOR_COURSE3Tool to retrieve navigation tabs for a Canvas group. Use when you need to see available navigation options for a specific group.Input Parameters
Output
List Available Tabs for User
List Available Tabs for User
CANVAS_LIST_AVAILABLE_TABS_FOR_USERTool to retrieve a paginated list of navigation tabs available in a user context. Use when you need to discover what tabs (like Home, Assignments, Grades, etc.) are accessible for a specific user.Input Parameters
Output
List blackout dates for account
List blackout dates for account
List Blueprint Imports
List Blueprint Imports
List Bookmarks
List Bookmarks
CANVAS_LIST_BOOKMARKSReturns the paginated list of bookmarks for the authenticated user. Use when you need to retrieve all bookmarks saved by the current user.Input Parameters
Output
List calendar events for current user
List calendar events for current user
CANVAS_LIST_CALENDAR_EVENTSRetrieves a paginated list of calendar events or assignments for the current user, with filters such as date ranges and context codes. Select the event type for each request.Input Parameters
Output
List calendar events for a user
List calendar events for a user
CANVAS_LIST_CALENDAR_EVENTS_FOR_USERRetrieves calendar events and assignments for a specific user from Canvas LMS, supporting extensive filtering options detailed in the request schema. Returned due_at values are ISO 8601 UTC; convert to user’s local timezone before display. For pending task identification, exclude items where locked_for_user is true or has_submitted_submissions is true. Results may be incomplete even when assignments exist; do not use as the sole source for pending task lists.Input Parameters
Output
List Enabled Features for a User
List Enabled Features for a User
CANVAS_LIST_CANVAS_ENABLED_FEATURES3Tool to retrieve a paginated list of enabled feature names for a Canvas user. Use when you need to check which optional features are currently active for a specific user.Input Parameters
Output
List external tools for course
List external tools for course
CANVAS_LIST_CANVAS_EXTERNAL_TOOLS2Tool to retrieve the paginated list of external tools for a course. Use when you need to discover LTI tools available in a course context.Input Parameters
Output
List closed poll sessions
List closed poll sessions
CANVAS_LIST_CLOSED_POLL_SESSIONSTool to retrieve a paginated list of all closed poll sessions available to the current user. Use when you need to see which poll sessions have been closed and their results.Input Parameters
Output
List communication messages
List communication messages
CANVAS_LIST_COMM_MESSAGESRetrieves communication messages from Canvas.Input Parameters
Output
List communication channels
List communication channels
CANVAS_LIST_COMMUNICATION_CHANNELSRetrieves a list of communication channels associated with a specific user in Canvas.Input Parameters
Output
List Conferences for Current User
List Conferences for Current User
CANVAS_LIST_CONFERENCES_FOR_CURRENT_USERTool to retrieve the paginated list of conferences for all courses and groups the current user belongs to. Use when you need to get conferences for the authenticated user.Input Parameters
Output
List content exports
List content exports
CANVAS_LIST_CONTENT_EXPORTSLists content export jobs for a course, one page at a time. Exports include their status, type, and download URLs when available, and can be downloaded as Common Cartridge (IMSCC), QTI, or ZIP files.Input Parameters
Output
List content exports for groups
List content exports for groups
CANVAS_LIST_CONTENT_EXPORTS_GROUPSLists content export jobs for a group, one page at a time. Exports include their status, type, and download URLs when available, and can be downloaded as Common Cartridge (IMSCC), QTI, or ZIP files.Input Parameters
Output
List content licenses for a course
List content licenses for a course
CANVAS_LIST_CONTENT_LICENSESTool to retrieve a list of content licenses that can be applied to course content in Canvas. Use when you need to know what license options are available for a specific course.Input Parameters
Output
List content migrations for user
List content migrations for user
CANVAS_LIST_CONTENT_MIGRATIONS4Tool to retrieve paginated content migrations for a specified user in Canvas. Use when you need to view the list of content migration operations initiated by or for a user.Input Parameters
Output
List content migrations for groups
List content migrations for groups
CANVAS_LIST_CONTENT_MIGRATIONS_GROUPSLists content migrations for a group, one page at a time. Returns migration status, progress URLs, and associated file or issue information when available.Input Parameters
Output
List Conversations
List Conversations
CANVAS_LIST_CONVERSATIONSTool to retrieve the paginated list of conversations for the current user, most recent ones first. Use when you need to fetch user conversations with optional filtering by scope (unread, starred, archived, sent) and context (courses, groups, users).Input Parameters
Output
List counts for todo items
List counts for todo items
CANVAS_LIST_COUNTS_FOR_TODO_ITEMSGet counts of different todo items for the current user, including assignments needing grading and assignments needing submitting. Note: Only counts the first 100 todo items.Input Parameters
Output
List blackout dates for course
List blackout dates for course
List Course Nicknames
List Course Nicknames
List courses
List courses
CANVAS_LIST_COURSESRetrieves a list of the current user’s courses from Canvas, optionally filtered by enrollment type and state. Excessive request frequency may return HTTP 429; respect the Retry-After header before retrying.Input Parameters
Output
List course sections
List course sections
CANVAS_LIST_COURSE_SECTIONSTool to retrieve a paginated list of sections for a specific course. Use when you need to get all sections or search for specific sections within a course.Input Parameters
Output
List Courses for a User
List Courses for a User
CANVAS_LIST_COURSES_FOR_USERRetrieves a list of courses in Canvas for a specified user_id, requiring observer or admin permissions to view courses for others.Input Parameters
Output
List Course Subgroups
List Course Subgroups
List courses with their latest ePub export
List courses with their latest ePub export
CANVAS_LIST_COURSES_WITH_THEIR_LATEST_E_PUB_EXPORTLists a page of courses the user is actively participating in with their latest ePub exports and export status. Use the returned next page to retrieve further results.Input Parameters
Output
List Course TODO Items
List Course TODO Items
List Course Users
List Course Users
CANVAS_LIST_COURSE_USERSRetrieves a paginated list of users for a given Canvas course_id (which must be an existing course), supporting various filtering, sorting, and data inclusion options.Input Parameters
enrollment_role_id instead for better precision.Output
List custom gradebook columns
List custom gradebook columns
CANVAS_LIST_CUSTOM_GRADEBOOK_COLUMNSReturns a paginated list of all custom gradebook columns for a course. Use when you need to retrieve custom columns that instructors have added to the gradebook.Input Parameters
Output
List Discussion Entries
List Discussion Entries
List Discussion Entry List
List Discussion Entry List
CANVAS_LIST_DISCUSSION_ENTRY_LISTTool to retrieve a paginated list of discussion entries by their ids from a group discussion topic. Use when needing to fetch specific entries given their identifiers. May require that the user has posted in the topic; if required and user has not posted, returns 403 Forbidden with body ‘require_initial_post’.Input Parameters
Output
List Discussion Topics
List Discussion Topics
CANVAS_LIST_DISCUSSION_TOPICSRetrieves a paginated list of discussion topics or announcements for a specified course.Input Parameters
Output
List discussion topics for group
List discussion topics for group
CANVAS_LIST_DISCUSSION_TOPICS2Tool to retrieve the paginated list of discussion topics for a specific group. Use when you need to list or browse discussion topics within a group context.Input Parameters
Output
List Enabled Features for a Course
List Enabled Features for a Course
CANVAS_LIST_ENABLED_FEATURES_COURSESTool to retrieve a paginated list of enabled feature names for a Canvas course. Use when you need to check which optional features are currently active on a specific course.Input Parameters
Output
List Enrollments
List Enrollments
CANVAS_LIST_ENROLLMENTSTool to retrieve a paginated list of enrollments for a course, section, or user. Use when you need to query enrollments with filters like type, state, or role.Input Parameters
Output
List Enrollment Terms
List Enrollment Terms
CANVAS_LIST_ENROLLMENT_TERMSTool to retrieve a paginated list of all enrollment terms in an account. Use when you need to query terms with filters like workflow state or search by name.Input Parameters
Output
List Entries By IDs
List Entries By IDs
CANVAS_LIST_ENTRIES_BY_IDSRetrieves discussion entries by ID from a course topic; access may require an initial post. Missing rating counts are returned as zero, and missing subscription and deletion flags as false.Input Parameters
Output
List entries for a column
List entries for a column
CANVAS_LIST_ENTRIES_FOR_COLUMNTool to retrieve entries from a custom gradebook column for a course. Use when you need to view data entered in custom columns. Note: Only returns entries for students with associated data; students without entries are excluded.Input Parameters
Output
List Entry Replies
List Entry Replies
List environment features
List environment features
List Environment Settings
List Environment Settings
List external feeds for group
List external feeds for group
List External Tools
List External Tools
CANVAS_LIST_EXTERNAL_TOOLSRetrieves the paginated list of external tools for the specified Canvas account. Use to discover LTI tools available in the account context.Input Parameters
Output
List favorite courses
List favorite courses
CANVAS_LIST_FAVORITE_COURSESTool to retrieve the paginated list of favorite courses for the current user. Use when you need to get the user’s favorite courses. If the user has not chosen any favorites, then a selection of currently enrolled courses will be returned.Input Parameters
Output
List favorite groups
List favorite groups
List Features for Course
List Features for Course
List Features for User
List Features for User
CANVAS_LIST_FEATURES_USERSRetrieves a paginated list of all features that apply to a given User. Use when checking which features are available or enabled for a specific user.Input Parameters
Output
List Files
List Files
List files in folder
List files in folder
CANVAS_LIST_FILES_IN_FOLDERTool to list files within a specific Canvas folder. Use when you need to retrieve files from a particular folder by its ID.Input Parameters
Output
List folders
List folders
List Global Subgroups
List Global Subgroups
List gradeable students
List gradeable students
List grading periods for a course
List grading periods for a course
CANVAS_LIST_GRADING_PERIODS_FOR_COURSEReturns the paginated list of grading periods for the current course. Use when you need to view grading period configurations for a specific course.Input Parameters
Output
List Grading Standards Available in Context
List Grading Standards Available in Context
CANVAS_LIST_GRADING_STANDARDS_AVAILABLE_IN_CONTEXTTool to retrieve grading standards available in a Canvas course context. Use when you need to list or view the grading schemes configured for a specific course.Input Parameters
Output
List group categories for a course
List group categories for a course
CANVAS_LIST_GROUP_CATEGORIES_FOR_A_CONTEXT2Retrieves a paginated list of group categories for a Canvas course, with an optional collaboration-state filter.Input Parameters
Output
List Group Entry Replies
List Group Entry Replies
CANVAS_LIST_GROUP_ENTRY_REPLIESTool to retrieve paginated replies to a top-level entry in a group discussion topic. Use when needing to list all replies to a particular discussion entry in a group. May require that the user has posted in the topic depending on topic settings.Input Parameters
Output
List external tools for group
List external tools for group
CANVAS_LIST_GROUP_EXTERNAL_TOOLSTool to retrieve the paginated list of external tools for a group. Use when you need to discover LTI tools available in a group context.Input Parameters
Output
List Group Files
List Group Files
CANVAS_LIST_GROUP_FILESTool to retrieve the paginated list of files for a specified group in Canvas. Use when you need to access or list files within a group context.Input Parameters
Output
List Group Memberships
List Group Memberships
List groups available in a context
List groups available in a context
CANVAS_LIST_GROUPS_AVAILABLE_IN_CONTEXTTool to retrieve the paginated list of active groups in a course context that are visible to the user. Use when you need to list all groups available in a specific course.Input Parameters
Output
List Groups in Account
List Groups in Account
CANVAS_LIST_GROUPS_IN_ACCOUNTRetrieves a paginated list of active groups visible to the user in a Canvas account, with membership and collaboration-state filters. A forbidden response is returned as an empty list, so an empty result does not necessarily mean the account has no groups.Input Parameters
Output
List group's users
List group's users
List Licenses
List Licenses
CANVAS_LIST_LICENSESRetrieves a paginated list of licenses that can be applied to content in Canvas. Use when setting usage rights for files or determining available licensing options.Input Parameters
Output
List licenses for a group
List licenses for a group
List linked outcomes for outcome group
List linked outcomes for outcome group
CANVAS_LIST_LINKED_OUTCOMESTool to retrieve a paginated list of the immediate OutcomeLink children of an outcome group. Use when you need to list outcomes linked to a specific outcome group within an account.Input Parameters
Output
List linked outcomes for course outcome group
List linked outcomes for course outcome group
CANVAS_LIST_LINKED_OUTCOMES2Tool to retrieve a paginated list of the immediate OutcomeLink children of an outcome group in a course. Use when you need to list outcomes linked to a specific outcome group within a course context.Input Parameters
Output
List LTI Launch Definitions for Course
List LTI Launch Definitions for Course
CANVAS_LIST_LTI_LAUNCH_DEFINITIONS_COURSESRetrieves LTI launch definitions for a Canvas course. Use to discover LTI app placements available in the course context. Note: If placements parameter is not provided, an empty list will be returned.Input Parameters
Output
List Manageable Accounts
List Manageable Accounts
CANVAS_LIST_MANAGEABLE_ACCOUNTSRetrieves Canvas accounts where the current user has permission to create or manage courses. Use when you need to see which accounts an admin can manage. List will be empty for students and teachers.Input Parameters
Output
List Media Objects
List Media Objects
CANVAS_LIST_MEDIA_OBJECTSTool to list media objects associated with a Canvas course. Use when you need to retrieve video/audio attachments for a specific course.Input Parameters
Output
List Media Objects 2
List Media Objects 2
CANVAS_LIST_MEDIA_OBJECTS2Tool to list media objects created by the user for a Canvas course. Use when you need to retrieve video/audio content associated with a specific course.Input Parameters
Output
List Media Objects for Group
List Media Objects for Group
CANVAS_LIST_MEDIA_OBJECTS3Tool to list media objects created by the user in a Canvas group. Use when you need to retrieve video/audio attachments for a specific group.Input Parameters
Output
List Media Objects for Group
List Media Objects for Group
CANVAS_LIST_MEDIA_OBJECTS4Tool to list media objects associated with a Canvas group. Use when you need to retrieve video/audio content for a specific group.Input Parameters
Output
List Media Objects for User
List Media Objects for User
CANVAS_LIST_MEDIA_OBJECTS6Tool to list media objects created by the authenticated user. Use when you need to retrieve video/audio objects uploaded by the current user across all courses.Input Parameters
Output
List migration issues
List migration issues
CANVAS_LIST_MIGRATION_ISSUESRetrieves a paginated list of issues for a content migration in a user’s Canvas context. Issues include severity, status, and available links for investigation or resolution.Input Parameters
Output
List migration systems for group
List migration systems for group
CANVAS_LIST_MIGRATION_SYSTEMS_GROUPSLists the currently available migration types for a Canvas group. Use this to determine which content import types are supported before creating a content migration. Migration types vary by Canvas instance and may include Common Cartridge, Canvas Cartridge, course copy, QTI, Moodle, and other importers.Input Parameters
Output
List migration systems for user
List migration systems for user
CANVAS_LIST_MIGRATION_SYSTEMS_USERSLists currently available migration types for importing content into a user’s Canvas context. Use this to discover which migration systems are supported before creating a content migration.Input Parameters
Output
List missing submissions for a user
List missing submissions for a user
CANVAS_LIST_MISSING_SUBMISSIONSList past-due assignments for which the student does not have a submission. The user making the request must either be the student, an admin, or a parent observer using the parent app. Use this to identify assignments that are overdue and still need to be completed.Input Parameters
Output
List module items
List module items
CANVAS_LIST_MODULE_ITEMSRetrieves a paginated list of items (assignments, quizzes, pages, files, etc.) from a specific module in a Canvas course. Use when you need to see the contents and structure of a module.Input Parameters
Output
List Modules
List Modules
CANVAS_LIST_MODULESTool to retrieve a paginated list of modules in a Canvas course. Use when you need to see all modules in a course, including their structure, items, and completion requirements.Input Parameters
Output
List My Admin Roles
List My Admin Roles
List notification preference categories
List notification preference categories
CANVAS_LIST_NOTIFICATION_PREFERENCE_CATEGORIESFetches all notification preference categories for a specific communication channel. Use this to discover which notification categories are available for configuring user notification preferences.Input Parameters
Output
List notification preferences
List notification preferences
CANVAS_LIST_NOTIFICATION_PREFERENCESTool to fetch all notification preferences for a given communication channel. Use when you need to retrieve how a user has configured notification delivery for a specific channel.Input Parameters
Output
List Observees
List Observees
CANVAS_LIST_OBSERVEESRetrieves a paginated list of observees for a Canvas user. All users can list their own observees; administrators can list observees for other users.Input Parameters
Output
List observers for a user
List observers for a user
CANVAS_LIST_OBSERVERSRetrieves a paginated list of observers linked to a given user. All users can list their own observers using user_id=‘self’. Administrators can list other users’ observers by providing the specific user_id.Input Parameters
Output
List opened poll sessions
List opened poll sessions
CANVAS_LIST_OPENED_POLL_SESSIONSTool to retrieve a paginated list of all opened poll sessions available to the current user. Use when you need to see which poll sessions are currently open.Input Parameters
Output
List pages for a course
List pages for a course
CANVAS_LIST_PAGES_FOR_COURSERetrieves a list of wiki pages associated with a specific, existing course in Canvas. Supports pagination via page and per_page query parameters for courses with many pages.Input Parameters
Output
List pages for a group
List pages for a group
CANVAS_LIST_PAGES_FOR_GROUPTool to retrieve a paginated list of wiki pages associated with a Canvas group. Use when you need to list pages for a specific group.Input Parameters
Output
List planner items for a user
List planner items for a user
CANVAS_LIST_PLANNER_ITEMSList a user’s cross-course Planner items (assignments, discussions, quizzes, etc.) within a date range, including Planner override/completion state. Use this to retrieve items from the Canvas dashboard/to-do planner view.Input Parameters
Output
List planner notes
List planner notes
CANVAS_LIST_PLANNER_NOTESRetrieve the paginated list of planner notes for the current authenticated user. Use to fetch personal to-do items and reminders from the Canvas planner.Input Parameters
Output
List Planner Overrides
List Planner Overrides
CANVAS_LIST_PLANNER_OVERRIDESRetrieves planner overrides for the currently authenticated user. Planner overrides allow users to mark plannable items as complete or dismissed in the Canvas planner.Input Parameters
Output
List poll choices in a poll
List poll choices in a poll
CANVAS_LIST_POLL_CHOICES_IN_A_POLLReturns the paginated list of poll choices in a poll. Use when you need to retrieve all available choices for a specific poll.Input Parameters
Output
List polls for current user
List polls for current user
CANVAS_LIST_POLLSRetrieves the paginated list of polls for the current authenticated user. Use when you need to view all polls created by or accessible to the user.Input Parameters
Output
List poll sessions for a poll
List poll sessions for a poll
CANVAS_LIST_POLL_SESSIONS_FOR_POLLTool to retrieve the paginated list of poll sessions for a specific poll. Use when you need to see all sessions associated with a particular poll.Input Parameters
Output
List notification preferences
List notification preferences
CANVAS_LIST_PREFERENCESFetches all notification preferences for a given communication channel. Use when you need to see all notification settings for a specific user’s communication channel.Input Parameters
Output
List questions in a quiz
List questions in a quiz
CANVAS_LIST_QUESTIONS_IN_QUIZReturns the paginated list of QuizQuestions in this quiz. Use when you need to retrieve all questions for a quiz, or questions from a specific submission attempt.Input Parameters
Output
List Quizzes in Course
List Quizzes in Course
CANVAS_LIST_QUIZZES_IN_COURSERetrieves a paginated list of quizzes for a specified, valid Canvas course, optionally filtering by a search term in the quiz title.Input Parameters
Output
List Recent History for a User
List Recent History for a User
CANVAS_LIST_RECENT_HISTORY_FOR_A_USERReturn a paginated list of the user’s recent browsing history in Canvas. History entries are returned in descending order, newest to oldest. Use to track recently visited assignments, pages, discussions, and other Canvas items.Input Parameters
Output
List revisions for a group page
List revisions for a group page
CANVAS_LIST_REVISIONS_FOR_GROUP_PAGETool to retrieve a paginated list of revisions for a specific page in a Canvas group. Use when you need to view the history of changes made to a group page. Callers must have update rights on the page to see its revision history.Input Parameters
Output
List Roles
List Roles
List Section Enrollments
List Section Enrollments
CANVAS_LIST_SECTION_ENROLLMENTSTool to retrieve a paginated list of enrollments for a specific section. Use when you need to query section enrollments with filters like type, state, or role.Input Parameters
Output
List Students
List Students
CANVAS_LIST_STUDENTSTool to retrieve the paginated list of students enrolled in a Canvas course. Use when you need to get student information for a specific course. DEPRECATED: The Canvas API recommends using the course users endpoint with enrollment_type=‘student’ instead.Input Parameters
Output
List Subgroups
List Subgroups
List submissions
List submissions
CANVAS_LIST_SUBMISSIONSFetches gradebook history submissions for a specific course, assignment, grader, and date from Canvas.Input Parameters
Output
List submissions for multiple assignments
List submissions for multiple assignments
CANVAS_LIST_SUBMISSIONSFOR_MULTIPLE_ASSIGNMENTSRetrieves submissions from a Canvas course for specified assignments and/or students; the course must be accessible.Input Parameters
Output
List submissions for multiple assignments in section
List submissions for multiple assignments in section
CANVAS_LIST_SUBMISSIONS_FOR_MULTIPLE_ASSIGNMENTS_SECTIONSRetrieves submissions from a Canvas section for specified assignments and/or students. Only the first page can be requested; a next-page indicator may be returned when more results exist.Input Parameters
Output
List the activity stream
List the activity stream
CANVAS_LIST_THE_ACTIVITY_STREAMTool to retrieve the current user’s global activity stream, paginated. Use when you need to see recent activities, notifications, or updates across all courses and groups the user is enrolled in.Input Parameters
Output
List the current user's TODO items
List the current user's TODO items
CANVAS_LIST_TODO_ITEMSRetrieves a paginated list of the current user’s todo items in Canvas. Use when you need to see pending tasks that require action, such as assignments needing submission or grading.Input Parameters
Output
List Topic Entries
List Topic Entries
List uncollated submission versions
List uncollated submission versions
CANVAS_LIST_UNCOLLATED_SUBMISSION_VERSIONSRetrieves a feed of uncollated submission versions from the Gradebook history for a course; any provided assignment_id must be valid for the course, and any user_id must be for a user enrolled in the course.Input Parameters
Output
List Upcoming Assignments Calendar Events
List Upcoming Assignments Calendar Events
CANVAS_LIST_UPCOMING_ASSIGNMENTS_CALENDAR_EVENTSTool to retrieve a paginated list of the current user’s upcoming events and assignments. Use when you need to see what’s coming up on the user’s calendar, including both calendar events and assignment due dates.Input Parameters
Output
List user content exports
List user content exports
CANVAS_LIST_USER_CONTENT_EXPORTSRetrieves the first page of past and pending content export jobs for a user, returned newest first, along with a next-page indicator when available.Input Parameters
Output
List User Enrollments
List User Enrollments
CANVAS_LIST_USER_ENROLLMENTSTool to retrieve a paginated list of all enrollments for a specific user. Use when you need to query a user’s enrollments across courses, with filters like type, state, or term.Input Parameters
Output
List User Files
List User Files
CANVAS_LIST_USER_FILESRetrieves the paginated list of files for a specific user. Use when you need to access or enumerate files uploaded by or accessible to a user.Input Parameters
Output
List user logins
List user logins
List User Logins
List User Logins
CANVAS_LIST_USER_LOGINS2Tool to retrieve a paginated list of logins for a specific Canvas user. Use when you need to see all login credentials associated with a particular user ID.Input Parameters
Output
List users in course
List users in course
CANVAS_LIST_USERS_IN_COURSETool to return the paginated list of users in a Canvas course. Use when you need to retrieve users enrolled in a specific course with optional enrollment details.Input Parameters
Output
List users in group category
List users in group category
CANVAS_LIST_USERS_IN_GROUP_CATEGORYRetrieves a page of users in a group category, optionally searching or filtering for unassigned users. The response may include a next-page number, but the tool cannot request subsequent pages.Input Parameters
Output
List your groups
List your groups
CANVAS_LIST_YOUR_GROUPSReturns a paginated list of active groups for the current user. Use this to retrieve all groups the authenticated user belongs to, optionally filtered by context type (Account or Course).Input Parameters
Output
Mark all conversations as read
Mark all conversations as read
Mark all entries as read
Mark all entries as read
CANVAS_MARK_ALL_ENTRIES_AS_READMarks a course discussion topic and all its entries as read for the current user.Input Parameters
Output
Mark all group discussion entries as read
Mark all group discussion entries as read
CANVAS_MARK_ALL_ENTRIES_AS_READ2Tool to mark the discussion topic and all its entries as read in a group. Use when you need to mark all entries in a group discussion topic as read for the current user.Input Parameters
Output
Mark all group discussion entries as unread
Mark all group discussion entries as unread
CANVAS_MARK_ALL_ENTRIES_AS_UNREAD2Tool to mark the discussion topic and all its entries as unread for a group. Use when you need to flag an entire group discussion and all its replies as unread.Input Parameters
Output
Mark all discussion topics as read
Mark all discussion topics as read
Mark all group discussion topics as read
Mark all group discussion topics as read
Mark bulk submissions as read
Mark bulk submissions as read
Mark bulk submissions as read (section)
Mark bulk submissions as read (section)
CANVAS_MARK_BULK_SUBMISSIONS_AS_READ2Marks multiple submissions as read for a specific section. Use when you need to mark several submissions as read at once for a section instead of marking them individually.Input Parameters
Output
Mark document annotations as read
Mark document annotations as read
CANVAS_MARK_DOCUMENT_ANNOTATIONS_AS_READMarks document annotations on a submitted assignment as read by the student. Use when a student has viewed feedback annotations on their submission. Only the student who owns the submission can mark annotations as read.Input Parameters
Output
Mark document annotations as read (section)
Mark document annotations as read (section)
CANVAS_MARK_DOCUMENT_ANNOTATIONS_AS_READ2Tool to mark annotations on a submitted document as read by the student. Use when a student needs to acknowledge they have viewed feedback annotations on their submitted document. Note: Document annotations are automatically marked as read when viewed in Canvas web.Input Parameters
Output
Mark group discussion entry as read
Mark group discussion entry as read
CANVAS_MARK_ENTRY_AS_READ_GROUPSTool to mark a discussion entry as read in a group context. Use when you need to change the read status of a specific discussion entry to read within a group discussion.Input Parameters
Output
Mark group discussion entry as unread
Mark group discussion entry as unread
CANVAS_MARK_GROUP_ENTRY_AS_UNREADTool to mark a group discussion entry as unread. Use when you need to change the read status of a specific discussion entry in a group back to unread.Input Parameters
Output
Mark module item as read
Mark module item as read
Mark rubric assessments as read
Mark rubric assessments as read
CANVAS_MARK_RUBRIC_ASSESSMENTS_AS_READTool to mark rubric comments/grading on a submission as read by the student. Use when a student needs to acknowledge they have viewed their rubric feedback. Note: Rubric assessments are automatically marked as read when viewed in Canvas web.Input Parameters
Output
Mark rubric assessments as read (sections)
Mark rubric assessments as read (sections)
CANVAS_MARK_RUBRIC_ASSESSMENTS_AS_READ_SECTIONSTool to mark rubric comments/grading on a submission as read by the student within a specific section. Use when a student needs to acknowledge they have viewed their rubric feedback. Only the student who owns the submission can use this endpoint.Input Parameters
Output
Mark submission as read (sections)
Mark submission as read (sections)
Mark submission as unread
Mark submission as unread
Mark submission comments as read
Mark submission comments as read
Mark group discussion topic as read
Mark group discussion topic as read
Mark group discussion topic as unread
Mark group discussion topic as unread
Set quiz accommodations
Set quiz accommodations
Set course quiz accommodations
Set course quiz accommodations
CANVAS_NEW_QUIZ_COURSE_ACCOMMODATIONS_SETEXPERIMENTAL: Sets course-level accommodations (extra time, apply-to-in-progress, reduced choices) for one or more students. These accommodations apply to all New Quizzes in the course. Sends a JSON array body.Input Parameters
Output
Create a new quiz
Create a new quiz
CANVAS_NEW_QUIZ_CREATEEXPERIMENTAL: Creates a New Quiz in a Canvas course with the specified title, dates, grading type, instructions, and nested quiz settings (attempts, result view, IP filtering, shuffling, time limit, etc.).Input Parameters
Output
Delete a new quiz
Delete a new quiz
Get a new quiz
Get a new quiz
Create a quiz item
Create a quiz item
Delete a quiz item
Delete a quiz item
Get a quiz item
Get a quiz item
List quiz items
List quiz items
Get items media upload URL
Get items media upload URL
Update a quiz item
Update a quiz item
List new quizzes
List new quizzes
Create a new quiz report
Create a new quiz report
CANVAS_NEW_QUIZ_REPORT_CREATEEXPERIMENTAL: Creates a report for a New Quiz. Starts an asynchronous job and returns a Progress object the caller can poll. Report type is ‘student_analysis’ or ‘item_analysis’; output format is ‘csv’ or ‘json’.Input Parameters
Output
Update a new quiz
Update a new quiz
Post assignment grades for sections
Post assignment grades for sections
CANVAS_POST_ASSIGNMENT_GRADES_FOR_SECTIONSTool to post assignment grades for specific sections in Canvas. Use when you need to release grades to students in particular course sections.Input Parameters
Output
Post group discussion entry
Post group discussion entry
CANVAS_POST_GROUP_DISCUSSION_ENTRYTool to create a new entry in a Canvas group discussion topic. Use when posting a message with optional attachment to a group discussion topic.Input Parameters
Output
Post group discussion reply
Post group discussion reply
CANVAS_POST_GROUP_DISCUSSION_REPLYTool to post a reply to a discussion entry in a group. Use when you need to add a reply to an entry in a group discussion topic. May require that the user has posted in the topic.Input Parameters
Output
Preview processed HTML
Preview processed HTML
CANVAS_PREVIEW_PROCESSED_HTMLTool to preview HTML content processed for a Canvas course. Use when you need to see how HTML will be rendered in Canvas after sanitization and link processing.Input Parameters
Output
Preview processed HTML for group
Preview processed HTML for group
CANVAS_PREVIEW_PROCESSED_HTML_FOR_GROUPTool to preview HTML content processed for a specific Canvas group. Use when you need to see how HTML will be rendered after Canvas applies group-specific processing and security policies.Input Parameters
Output
Query progress
Query progress
CANVAS_QUERY_PROGRESSTool to return completion and status information about an asynchronous job in Canvas LMS. Use when you need to check the status of a long-running operation.Input Parameters
Output
Rate group discussion entry
Rate group discussion entry
CANVAS_RATE_GROUP_DISCUSSION_ENTRYTool to rate a discussion entry in a Canvas group. Use when you need to add or remove a rating (like/unlike) on a group discussion entry.Input Parameters
Output
Redirect to Assignment Override for Section
Redirect to Assignment Override for Section
Redirect to Root Outcome Group for Context
Redirect to Root Outcome Group for Context
Remove course from favorites
Remove course from favorites
Remove Course Nickname
Remove Course Nickname
Remove feature flag for users
Remove feature flag for users
CANVAS_REMOVE_FEATURE_FLAG_USERSRemove feature flag for a given User. The flag must be defined directly on the User. After removal, the user will inherit feature flags from a higher account if any exist.Input Parameters
Output
Remove group from favorites
Remove group from favorites
Remove usage rights from group files
Remove usage rights from group files
CANVAS_REMOVE_USAGE_RIGHTS_GROUPSTool to remove copyright and license information from one or more files in a group. Use when you need to clear usage rights metadata from group files.Input Parameters
Output
Remove usage rights from user files
Remove usage rights from user files
CANVAS_REMOVE_USAGE_RIGHTS_USERSTool to remove copyright and license information from one or more files for a user. Use when you need to clear usage rights metadata from user files.Input Parameters
Output
Reorder custom gradebook columns
Reorder custom gradebook columns
CANVAS_REORDER_CUSTOM_COLUMNSReorders custom gradebook columns in a course. Use when you need to change the display order of custom columns in the gradebook.Input Parameters
Output
Reorder pinned topics for group
Reorder pinned topics for group
CANVAS_REORDER_PINNED_TOPICS_FOR_GROUPTool to reorder pinned discussion topics in a Canvas group. Use when you need to change the display order of pinned topics in a group.Input Parameters
Output
Reset Course Favorites
Reset Course Favorites
Reset group favorites
Reset group favorites
Reset link verifier
Reset link verifier
Resolve Folder Path
Resolve Folder Path
CANVAS_RESOLVE_FOLDER_PATHResolves a folder path and returns the complete hierarchy. Given the full path to a folder, returns a list of all Folders in the path hierarchy starting at the root folder and ending at the requested folder. Use when you need to navigate or verify folder structure within a user’s files.Input Parameters
Output
Resolve group folder path
Resolve group folder path
CANVAS_RESOLVE_GROUP_FOLDER_PATHTool to retrieve folder hierarchy by resolving a path within a Canvas group. Use when you need to traverse a folder path or verify a folder exists at a specific location within a group.Input Parameters
Output
Retrieve All Quiz Reports
Retrieve All Quiz Reports
CANVAS_RETRIEVE_ALL_QUIZ_REPORTSRetrieves a list of all available reports for a specified quiz. Use when you need to see what quiz reports exist or check their status.Input Parameters
Output
Retrieve assignment overridden dates for Classic Quizzes
Retrieve assignment overridden dates for Classic Quizzes
CANVAS_RETRIEVE_ASSIGNMENT_OVERRIDDEN_DATES_FOR_CLASSICRetrieves the actual due-at, unlock-at, and lock-at dates for Classic Quizzes based on assignment overrides active for the current API user. Use this to get personalized quiz dates that reflect section overrides, group overrides, or individual student overrides.Input Parameters
Output
Retrieve assignment overridden dates for New Quizzes
Retrieve assignment overridden dates for New Quizzes
CANVAS_RETRIEVE_ASSIGNMENT_OVERRIDDEN_DATES_FOR_NEWRetrieves the actual due-at, unlock-at, and lock-at dates for New Quizzes based on assignment overrides active for the current API user. Use this to get personalized quiz dates that reflect section overrides, group overrides, or individual student overrides.Input Parameters
Output
Retrieve enrollment term
Retrieve enrollment term
CANVAS_RETRIEVE_ENROLLMENT_TERMRetrieves detailed information for a specific enrollment term within a given root account in Canvas.Input Parameters
Output
Retrieve Internal Setting
Retrieve Internal Setting
Revert Group Page to Revision
Revert Group Page to Revision
CANVAS_REVERT_GROUP_PAGE_TO_REVISIONTool to revert a Canvas group page to a prior revision. Use when you need to restore a group page to a previous version, undoing recent changes.Input Parameters
Output
Save enabled account calendars
Save enabled account calendars
CANVAS_SAVE_ENABLED_ACCOUNT_CALENDARSTool to save user preferences for enabled account calendars and mark the feature as seen. Use when updating which account calendars a user has enabled or marking that the user has viewed the account calendars feature.Input Parameters
Output
Set course nickname
Set course nickname
CANVAS_SET_COURSE_NICKNAMETool to set a nickname for a specific Canvas course. Use when you need to assign a custom name to a course that will appear in API outputs and the Canvas web interface.Input Parameters
Output
Set extensions for student quiz submissions
Set extensions for student quiz submissions
CANVAS_SET_EXTENSIONS_FOR_STUDENT_QUIZ_SUBMISSIONSSets extensions for student quiz submissions in a course, including extra attempts, extra time, and extensions to a quiz’s end time. Returns the quiz extension records.Input Parameters
Output
Set feature flag for course
Set feature flag for course
CANVAS_SET_FEATURE_FLAG_COURSESTool to set a feature flag for a given Course. Use when you need to enable or disable a Canvas feature at the course level. This call will fail if a parent account sets a feature flag for the same feature in any state other than “allowed”.Input Parameters
Output
Set feature flag for user
Set feature flag for user
CANVAS_SET_FEATURE_FLAG_USERSTool to set a feature flag for a given User. Use when you need to enable or disable a Canvas feature at the user level. This call will fail if a parent account sets a feature flag for the same feature in any state other than “allowed”.Input Parameters
Output
Set friendly description
Set friendly description
CANVAS_SET_FRIENDLY_DESCRIPTIONTool to set a friendly description for a learning outcome in Canvas using GraphQL. Use when you need to add or update a user-friendly explanation for an outcome in a specific course or account context.Input Parameters
Output
Set module item completion
Set module item completion
Set override status
Set override status
Set usage rights for group files
Set usage rights for group files
CANVAS_SET_USAGE_RIGHTS_GROUPSSets copyright and license information for files in a Canvas group, including files selected through folders. It can also request that the selected files or folders be published on save.Input Parameters
Output
Set usage rights for user files
Set usage rights for user files
CANVAS_SET_USAGE_RIGHTS_USERSSets copyright and license information for files in a Canvas user’s account, including files selected through folders. It can also request that the selected files or folders be published on save.Input Parameters
Output
Show an observee
Show an observee
CANVAS_SHOW_AN_OBSERVEETool to get information about an observed user. Use when you need to retrieve details about a user being observed by another user. Note that all users are allowed to view their own observees.Input Parameters
Output
Show a planner override
Show a planner override
Show content export
Show content export
Show ePub export
Show ePub export
Show Front Page for Group
Show Front Page for Group
Show group content export
Show group content export
Show Group Page Revision
Show Group Page Revision
CANVAS_SHOW_GROUP_PAGE_REVISIONTool to retrieve the metadata and optionally content of the latest revision of a page in a Canvas group. Use when you need to view the most recent version of a group page. Note that retrieving historic versions requires edit rights.Input Parameters
Output
Show an outcome
Show an outcome
CANVAS_SHOW_OUTCOMERetrieves detailed information for a specific outcome in Canvas using its ID. Use when you need to view outcome details, ratings, or mastery settings.Input Parameters
Output
Show page for a group
Show page for a group
CANVAS_SHOW_PAGE_FOR_GROUPRetrieves the content of a specific wiki page by its URL or numeric ID from a Canvas group. Use when you need to fetch the full content and metadata of a group’s wiki page.Input Parameters
Output
Show a planner note
Show a planner note
Show revision for group page
Show revision for group page
CANVAS_SHOW_REVISION_FOR_GROUP_PAGETool to retrieve the metadata and optionally content of a specific revision of a group page. Use when you need to view a historic version of a page. Note that retrieving historic versions requires edit rights.Input Parameters
Output
Show Temporary Enrollment Status
Show Temporary Enrollment Status
CANVAS_SHOW_TEMPORARY_ENROLLMENT_STATUSRetrieve a Canvas user’s temporary enrollment status, including provider, recipient, and permission indicators. For a 204 or empty response, the tool returns all three indicators as false.Input Parameters
Output
Show User Details
Show User Details
CANVAS_SHOW_USER_DETAILSTool to retrieve detailed information about a specific Canvas user by ID. Use when you need to fetch profile data, permissions, and other user attributes for a given user.Input Parameters
Output
Start a Report
Start a Report
CANVAS_START_REPORTInitiates an asynchronous report generation for a Canvas account, using a valid report type for the account; the response confirms initiation and may include progress tracking details.Input Parameters
courses[course_id]). Consult ‘List Available Reports’ or API documentation for parameter details. Omit if none are needed.Output
Submit assignment
Submit assignment
CANVAS_SUBMIT_ASSIGNMENTTool to make a submission for an assignment in Canvas. Use when a student needs to submit their work for an assignment. You must be enrolled as a student in the course/section to do this. All online turn-in submission types are supported (text, URL, file upload, media recording, LTI launch, student annotation).Input Parameters
Output
Subscribe to discussion topic
Subscribe to discussion topic
Subscribe to a topic
Subscribe to a topic
Subscribe to a topic in group
Subscribe to a topic in group
Translate File Reference
Translate File Reference
CANVAS_TRANSLATE_FILE_REFERENCEResolves a file’s migration ID to its current representation within a specific Canvas course. Use it to find the course file associated with a reference from a content import.Input Parameters
Output
Unsubscribe from a topic in group
Unsubscribe from a topic in group
Update a content migration for user
Update a content migration for user
CANVAS_UPDATE_A_CONTENT_MIGRATION4Tool to update a content migration for a user in Canvas. Use when you need to modify migration settings, handle file upload problems, or configure selective imports. Note: migration_type cannot be changed, and most settings changes after the migration has started will have no effect.Input Parameters
Output
Update a membership
Update a membership
Update an entry
Update an entry
CANVAS_UPDATE_AN_ENTRYUpdates the message of an existing Canvas course discussion entry. The entry must have been created by the current user, or the current user must have admin rights to the discussion.Input Parameters
Output
Update a planner override
Update a planner override
CANVAS_UPDATE_A_PLANNER_OVERRIDEUpdate a planner override’s visibility and completion status for the current user. Use this to mark planner items as complete/incomplete or dismiss/show them in the opportunities list.Input Parameters
Output
Update Appointment Group
Update Appointment Group
CANVAS_UPDATE_APPOINTMENT_GROUPUpdates an existing Canvas appointment group by its ID; only provided fields are modified, but publish defaults to False if omitted. The appointment_group_id must be valid.Input Parameters
Output
Update notification preference
Update notification preference
CANVAS_UPDATE_A_PREFERENCEUpdates the current user’s notification preference for a single notification on a specific communication channel, changing its delivery frequency.Input Parameters
Output
Update Bookmark
Update Bookmark
CANVAS_UPDATE_BOOKMARKUpdates an existing bookmark for the authenticated user. Use when you need to modify the name, URL, position, or metadata of a bookmark.Input Parameters
Output
Update Calendar Event
Update Calendar Event
CANVAS_UPDATE_CALENDAR_EVENTUpdates a Canvas calendar event’s details, such as title, description, timing, or location. For recurring events, it can target the individual event, the entire series, or the event and those following.Input Parameters
Output
Update comment bank item
Update comment bank item
CANVAS_UPDATE_COMMENT_BANK_ITEMTool to update an existing comment bank item in Canvas. Use when modifying the text of a previously saved grading comment.Input Parameters
Output
Update conversation participants
Update conversation participants
CANVAS_UPDATE_CONVERSATION_PARTICIPANTSTool to batch update conversation workflow states in Canvas. Use when you need to mark conversations as read/unread, star/unstar, archive, or delete multiple conversations at once.Input Parameters
Output
Update course
Update course
CANVAS_UPDATE_COURSEUpdates an existing course, specified by its ID, with new attributes or triggers a lifecycle event like ‘conclude’ or ‘delete’.Input Parameters
true, API updates can override SIS-controlled fields; if false, updates to ‘sticky’ SIS fields are prevented.Output
Update course settings
Update course settings
CANVAS_UPDATE_COURSE_SETTINGSUpdates various settings for an existing course in Canvas, identified by course_id.Input Parameters
show_announcements_on_home_page is enabled. Only applicable if the home page is a Wiki.home_page_announcement_limit. This setting is ignored by Canvas for Elementary subjects.Output
Update/Create Front Page for Groups
Update/Create Front Page for Groups
CANVAS_UPDATE_CREATE_FRONT_PAGE_GROUPSTool to update or create the front page of a Canvas group wiki. Use when you need to modify the title or contents of the group front page.Input Parameters
Output
Update Custom Color
Update Custom Color
CANVAS_UPDATE_CUSTOM_COLORTool to update the custom color for a user for a specific course or context in Canvas. Use when you need to set or modify user-specific color preferences for calendar and other UI elements.Input Parameters
Output
Update a custom gradebook column
Update a custom gradebook column
CANVAS_UPDATE_CUSTOM_GRADEBOOK_COLUMNUpdates an existing custom gradebook column in a course. Use when you need to modify properties like title, position, visibility, or editability of a custom gradebook column.Input Parameters
Output
Bulk update custom gradebook column data
Bulk update custom gradebook column data
CANVAS_UPDATE_CUSTOM_GRADEBOOK_COLUMN_DATABulk updates custom gradebook column data for multiple student and column combinations in a course. Returns a progress object for tracking the operation.Input Parameters
Output
Update discussion entries read state
Update discussion entries read state
Update discussion entry
Update discussion entry
Update discussion entry participant
Update discussion entry participant
CANVAS_UPDATE_DISCUSSION_ENTRY_PARTICIPANTTool to update a discussion entry participant’s read state or rating. Use when marking entries as read/unread or changing ratings.Input Parameters
Output
Update discussion read state
Update discussion read state
CANVAS_UPDATE_DISCUSSION_READ_STATETool to update the read state for a discussion topic in Canvas via GraphQL. Use when marking a discussion as read or unread for the current user.Input Parameters
Output
Update discussion thread read state
Update discussion thread read state
Update discussion topic (GraphQL)
Update discussion topic (GraphQL)
Update file
Update file
CANVAS_UPDATE_FILEModifies an existing file’s name or relocates it to a new parent folder; the target folder, if specified, must be valid and in the file’s original context.Input Parameters
name already exists in the target parent_folder_id. Valid options are: ‘rename’ (the uploaded file will be renamed to avoid conflict, e.g., ‘filename (1).txt’) or ‘overwrite’ (the existing file will be replaced). If not provided or null, the Canvas API’s default behavior for handling duplicates will apply.Output
Update Folder
Update Folder
CANVAS_UPDATE_FOLDERUpdates an existing folder’s properties (name, position, lock state, visibility) specified by its unique ID. Use when modifying folder attributes.Input Parameters
Output
Update a group content migration
Update a group content migration
CANVAS_UPDATE_GROUP_CONTENT_MIGRATIONTool to update a content migration in a Canvas group. Use when you need to modify migration settings, handle file upload problems, configure selective imports, or specify which content to copy. Note: migration_type cannot be changed, and most settings changes after the migration has started will have no effect.Input Parameters
Output
Update group discussion entry
Update group discussion entry
CANVAS_UPDATE_GROUP_DISCUSSION_ENTRYTool to update an existing discussion entry in a Canvas group. Use when editing a group discussion entry’s message content. The entry must have been created by the current user, or the current user must have admin rights to the discussion.Input Parameters
Output
Update multiple notification preferences
Update multiple notification preferences
CANVAS_UPDATE_MULTIPLE_NOTIFICATION_PREFERENCESUpdates multiple notification preferences for one of the authenticated user’s communication channels, identified by channel type and address.Input Parameters
Output
Update multiple preferences by channel ID
Update multiple preferences by channel ID
CANVAS_UPDATE_MULTIPLE_PREFERENCES_BY_CHANNEL_IDUpdates multiple notification preferences for one of the authenticated user’s communication channels by channel ID. Frequencies can be immediately, daily, weekly, or never.Input Parameters
Output
Update notification preferences
Update notification preferences
CANVAS_UPDATE_NOTIFICATION_PREFERENCESTool to update user notification preferences in Canvas using GraphQL. Use when configuring how and when a user receives notifications for specific categories through a communication channel.Input Parameters
Output
Update page for a course
Update page for a course
Update a page for a group
Update a page for a group
CANVAS_UPDATE_PAGE_FOR_GROUPUpdates the title or contents of an existing wiki page in a Canvas group. Use when you need to modify group documentation, notes, or collaborative content.Input Parameters
Output
Update a planner note
Update a planner note
CANVAS_UPDATE_PLANNER_NOTEUpdate a planner note for the current user. Use when modifying an existing to-do item or reminder in the Canvas planner.Input Parameters
Output
Update notification preference by type and address
Update notification preference by type and address
CANVAS_UPDATE_PREFERENCE_BY_TYPE_AND_ADDRESSUpdates the frequency preference for a single notification on a communication channel belonging to the authenticated user, identified by type and address.Input Parameters
Output
Update preferences by category
Update preferences by category
Update quiz submission scores
Update quiz submission scores
CANVAS_UPDATE_QUIZ_SUBMISSION_SCORESUpdates scores, comments for questions, and/or applies fudge points to a specific quiz submission attempt; the attempt must be completed and referenced by valid, existing course, quiz, and submission IDs.Input Parameters
Output
Update rubric assessment read state
Update rubric assessment read state
Update Single Poll
Update Single Poll
Update a single poll choice
Update a single poll choice
Update Single Poll Session
Update Single Poll Session
Update SpeedGrader settings
Update SpeedGrader settings
CANVAS_UPDATE_SPEED_GRADER_SETTINGSTool to update SpeedGrader settings in Canvas via GraphQL. Use when you need to configure SpeedGrader options such as enabling grade-by-question mode.Input Parameters
Output
Update split screen view deeply nested alert
Update split screen view deeply nested alert
CANVAS_UPDATE_SPLIT_SCREEN_VIEW_DEEPLY_NESTED_ALERTTool to update the split screen view deeply nested alert setting for a user. Use when enabling or disabling the deeply nested alert warning in split screen view mode.Input Parameters
Output
Update submission student-entered score
Update submission student-entered score
CANVAS_UPDATE_SUBMISSION_STUDENT_ENTERED_SCORETool to update the student-entered score (what-if score) for a submission. Use when a student wants to set or modify a hypothetical score to calculate potential grades.Input Parameters
Output
Update submission what-if score
Update submission what-if score
Update group discussion topic
Update group discussion topic
CANVAS_UPDATE_TOPIC_FOR_GROUPTool to update an existing discussion topic for a group. Use when modifying the title, message, publication settings, or engagement features of a group discussion topic.Input Parameters
Output
Update user discussions splitscreen view
Update user discussions splitscreen view
Update User Settings
Update User Settings
CANVAS_UPDATE_USER_SETTINGSUpdates a Canvas user’s preferences for various interface elements and content interaction behaviors.Input Parameters
true, course navigation menus will load collapsed by default.true, the global navigation menu will load collapsed by default.true, user must manually mark discussion posts as read; false means posts are marked read automatically upon viewing.true, the classic Canvas dashboard view is displayed; false displays the Canvas for Elementary view.Output
Update user text editor preference
Update user text editor preference
CANVAS_UPDATE_USERS_TEXT_EDITOR_PREFERENCETool to update a user’s text editor preference. Use when you need to change the default text editor for a user in Canvas.Input Parameters
Output
Update User Token
Update User Token
CANVAS_UPDATE_USERS_TOKENSTool to update an existing access token for a Canvas user. Use when you need to modify token properties like purpose, expiration, scopes, or regenerate the token value.Input Parameters
Output
Upload a course file
Upload a course file
CANVAS_UPLOAD_COURSE_FILEUploads a file to an accessible Canvas course, optionally to a specific folder (created if a non-existent parent_folder_path is provided) and with defined behavior for duplicate filenames.Input Parameters
parent_folder_path.parent_folder_id.Output
Upload a file to group
Upload a file to group
CANVAS_UPLOAD_FILE_TO_GROUPInitiates file upload to a Canvas group (Step 1 of 3-step workflow). Returns upload_url and upload_params needed for Step 2. Only users with ‘Manage Files’ permission can upload to groups.Input Parameters
Output
Upload submission file
Upload submission file
CANVAS_UPLOAD_SUBMISSION_FILEUploads a file for an assignment submission in Canvas (step 1 of submitting); the returned file can later be included in an actual submission. The specified user must be enrolled in the course with access to the assignment. Use ‘self’ for user_id to upload as the authenticated user, or specify another user’s ID (requires masquerade permissions).Input Parameters
Output
Upsert custom grade status
Upsert custom grade status
CANVAS_UPSERT_CUSTOM_GRADE_STATUSTool to create or update a custom grade status in Canvas. Use when you need to add a new custom grade status or modify an existing one.Input Parameters
Output
Upsert standard grade status
Upsert standard grade status
CANVAS_UPSERT_STANDARD_GRADE_STATUSTool to create or update a standard grade status in Canvas. Use when customizing standard grade status labels and colors. Standard grade statuses include: late, missing, excused, and none.Input Parameters
Output
Triggers
Canvas Assignment Graded
Canvas Assignment Graded
New Canvas Assignment Submission
New Canvas Assignment Submission
New Canvas Discussion Message
New Canvas Discussion Message
New Canvas Discussion Topic
New Canvas Discussion Topic
CANVAS_NEW_CANVAS_DISCUSSION_TRIGGERType: pollPolls a Canvas course for new discussion topics.Configuration
Payload
New Course Created for User
New Course Created for User