Skip to main content
Canvas logo
  • Category: online courses
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? No
  • Tools: 574
  • Triggers: 6
  • Slug: CANVAS
  • Version: 20261101_00

Tools

Slug: CANVAS_ABORT_QUIZ_REPORT_GENERATIONAborts the generation of a quiz report or removes a previously generated one. Use when you need to cancel a report generation request or clean up an old report.

Input Parameters

string
required
The ID of the specific quiz report to abort or remove.
string
required
The ID of the quiz for which the report generation is to be aborted.
string
required
The ID of the course containing the quiz.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The content of the message to be sent.
array
required
Array of recipient user IDs who should receive this message. User IDs are numeric strings.
string
The course or group ID that provides context for this message (e.g., ‘course_123’, ‘group_456’).
array
Array of attachment IDs to include with the message. These are IDs of files previously uploaded.
string
required
The unique identifier of the conversation to add a message to.
string
Media comment ID of an audio or video file to be associated with this message.
array
Array of message IDs to include or reference in this message.
string
Type of the associated media file. Must be ‘audio’ or ‘video’ if media_comment_id is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_ADD_COURSE_TO_FAVORITESTool to add a course to the current user’s favorites. Use when you need to favorite a course for the authenticated user. If the course is already in the user’s favorites, nothing happens.

Input Parameters

string
required
The unique identifier of the course to add to favorites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_ADD_GROUP_TO_FAVORITESTool to add a group to the current user’s favorites. Use when you need to mark a group as favorite for the authenticated user. If the group is already in the user’s favorites, nothing happens.

Input Parameters

string
required
The unique identifier of the group to add to favorites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The last attended date of a student enrollment in a course. Must be in ISO 8601 date format (YYYY-MM-DD).
string
required
The unique identifier of the user (student) whose last attended date is being updated.
string
required
The unique identifier of the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the conversation to add recipients to.
array
required
An array of recipient ids. These may be user ids or course/group ids prefixed with ‘course_’ or ‘group_’ respectively (e.g., ‘1’, ‘2’, ‘course_3’, ‘group_456’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_ADD_USERS_TO_CONTENT_SHARETool to send a previously created content share to additional users. Use when you need to add more recipients to an existing content share.

Input Parameters

string
required
The unique identifier of the content share to add users to.
string
required
The user ID who owns the content share, or ‘self’ for the current user.
array
required
Array of user IDs to share the content with. Each ID must be a valid Canvas user identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The attempt number of the quiz submission being taken. This must be the latest attempt index, as questions for earlier attempts cannot be modified.
string
Access code for the Quiz, if any is required.
array
Array of question IDs and their answer values. See Canvas API documentation for accepted answer formats for each question type (multiple choice, essay, fill-in-the-blank, etc.).
string
required
The unique validation token received when the Quiz Submission was created. This is required to validate the submission.
string
required
The unique ID of the quiz submission to answer questions for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
If true, runs synchronously and returns group memberships. If false (default), runs asynchronously and returns a Progress object for tracking the operation.
string
required
The unique identifier of the group category to assign unassigned members to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CLEAR_COURSE_NICKNAMESTool to remove all stored course nicknames for the current user. Use when you need to clear all custom course name preferences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the account notification to close/excuse for the current user.
boolean
If true, permanently destroys the account notification (admin action). If false or omitted, the notification is excused only for the current user.
string
required
The unique identifier of the Canvas account containing the notification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CONCLUDE_DEACTIVATE_OR_DELETE_ENROLLMENTTool to conclude, deactivate, or delete an enrollment in a Canvas course. Use when you need to end or remove a user’s enrollment. If the task argument isn’t given, the enrollment will be concluded.

Input Parameters

string
required
The ID of the enrollment to conclude, deactivate, or delete.
string ("conclude" | "delete" | "inactivate" | "deactivate")
The action to take on the enrollment.
string
required
The ID of the course containing the enrollment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("overwrite" | "rename")
Specifies behavior when a file with the same name exists at the destination. Use ‘overwrite’ to replace the existing file or ‘rename’ to create a copy with a modified name (e.g., ‘filename (1).txt’).
string
required
The unique identifier of the destination folder where the file will be copied.
string
required
The unique identifier of the source file to be copied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_COPY_FOLDERTool to copy a folder to another folder in Canvas. Use when you need to duplicate a folder structure with its contents to a destination folder.

Input Parameters

string
required
The destination folder ID where the source folder will be copied.
string
required
The ID of the source folder to copy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_ACCOUNT_NOTIFICATIONCreates a global notification within a Canvas account, with a visibility period and optional recipient roles.

Input Parameters

string ("warning" | "information" | "question" | "error" | "calendar")
Icon to display with the notification.
string
required
End date/time for visibility (ISO8601 format); must be after start_at.
string
required
Main content/body of the notification.
string
required
Subject line of the notification.
string
required
Start date/time for visibility (ISO8601 format).
string
required
Canvas account ID for the notification.
array
Optional list of specific user role(s) to receive the notification (e.g., ‘StudentEnrollment’, ‘TeacherEnrollment’); roles must be valid for the account. If omitted, Canvas defaults to broader visibility.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
For course_copy_importer migrations, select objects to copy without using selective_import workflow. Keys are object types (e.g., ‘files’, ‘folders’, ‘pages’), values are lists of object ids.
string
required
The unique identifier for the Canvas user where the content migration will be created. Use ‘self’ to refer to the authenticated user.
object
Settings for content migration configuration.
string ("canvas_cartridge_importer" | "common_cartridge_importer" | "course_copy_importer" | "zip_file_importer" | "qti_converter" | "moodle_converter")
required
The type of the migration. Use the Migrator endpoint to see all available migrators.
object
Parameters for pre-uploading a file for content migration.
boolean
If true, perform a selective import instead of importing all content. The migration will identify contents and stop in ‘waiting_for_select’ state. Use the List items endpoint to enumerate contents, then call the Update endpoint with copy parameters to start import.
object
Date shifting options for migrated content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_APPOINTMENT_GROUPCreates a new appointment group in Canvas for schedulable time slots within specified course or group contexts.

Input Parameters

string
required
Title for the appointment group (e.g., ‘Office Hours’).
boolean
If True, publishes the appointment group making it visible for sign-ups.
string
Longer description or instructions for participants.
array
required
Context codes (e.g., ‘course_123’) to link this appointment group; at least one is required.
string
Name of the location (e.g., ‘Room 301’, ‘Online via Zoom’).
string
Address for the location (e.g., physical address or meeting URL).
array
Nested array of start/end time pairs (ISO 8601 format) indicating time slots for this appointment group. Each inner list should contain exactly 2 strings: [start_time, end_time].
array
Sub-context codes (e.g., ‘section_789’) to further restrict the group within primary context_codes.
boolean
If True, allows users with an observer role (e.g., parents, mentors) to sign up.
string ("private" | "protected")
Controls sign-up visibility: ‘private’ (organizers only see sign-ups) or ‘protected’ (participants see others in the same slot).
integer
Maximum participants per time slot. If unspecified, Canvas may apply a default or allow unlimited.
integer
Maximum time slots a participant can sign up for; prevents overbooking.
integer
Minimum time slots a participant must sign up for; useful for requiring multiple sessions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_ASSIGNMENTCreates a new assignment within a specified course in Canvas LMS.

Input Parameters

string
required
Name of the assignment.
string
Due date in ISO 8601 format.
integer
Position in the assignment group’s list; lower numbers appear first. If unspecified, added to the end.
string
required
ID of the course for the new assignment.
boolean
If true, assignment is published and visible to students. Defaults to false (draft).
string
Date assignment becomes available to students, in ISO 8601 format.
string
Detailed HTML description, including instructions or requirements.
string
Grading type. Supported: ‘pass_fail’, ‘percent’, ‘letter_grade’, ‘gpa_scale’, ‘points’, ‘not_graded’. Defaults to ‘points’ if unspecified.
string
Unique identifier if managed by a third-party integration (e.g., LTI ID).
integer
Maximum points possible. Required unless grading_type is ‘pass_fail’ or ‘not_graded’.
integer
Number of submission attempts allowed. Use -1 for unlimited. Defaults to -1 (unlimited) if unspecified by the system.
array
Submission types allowed. Common: ‘online_text_entry’, ‘online_upload’, ‘on_paper’, ‘none’, ‘external_tool’. If unspecified, Canvas often assumes ‘none’.
array
File extensions allowed if ‘online_upload’ is a submission type. If unspecified, all file types are allowed.
integer
ID of the assignment group for this assignment. If unspecified, may be added to a default or first available group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the assignment. This is a required field.
string
Due date in ISO 8601 format.
string ("published" | "unpublished" | "deleted")
Publication state of the assignment.
string
Date assignment becomes unavailable to students, in ISO 8601 format.
string
required
ID of the course where the assignment will be created. This is a required field.
integer
Position in the assignment group’s list; lower numbers appear first.
string
Date assignment becomes available to students, in ISO 8601 format.
array
IDs of course modules to associate with this assignment.
boolean
Whether to send grades to the Student Information System.
string
ID of the group set for this assignment.
string
Detailed HTML description of the assignment, including instructions or requirements.
string ("points" | "percent" | "letter_grade" | "gpa_scale" | "pass_fail" | "not_graded")
Grading type for the assignment.
object
Peer review configuration for the assignment.
string
Security parameters for the assignment.
boolean
If true, this assignment is a parent assignment for checkpoints.
number
Maximum points possible for the assignment.
integer
Number of submission attempts allowed. Use -1 for unlimited.
string
ID of the group category if this is a group assignment.
array
Allowed submission types for the assignment.
boolean
Whether grading should be anonymous. Requires anonymous_marking course feature.
object
Moderated grading settings for the assignment.
array
Valid file extensions if ‘online_upload’ is a submission type.
string
ID of the assignment group for this assignment.
string
ID of the grading standard to use.
boolean
Whether to exclude this assignment from final grade calculations.
boolean
Whether to hide the assignment from students.
array
Date and access overrides for specific students, sections, or groups.
boolean
Whether the assignment is only visible to students with overrides.
boolean
Whether instructor annotations are hidden from students.
boolean
If a group assignment, whether students will be graded individually.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The assignment group’s name. If not provided, Canvas will assign a default name.
integer
The position of this assignment group in relation to the other assignment groups. If not specified, it will be placed at the end.
string
required
The unique identifier of the course in which to create the assignment group.
number
The percent of the total grade that this assignment group represents. Must be a number between 0 and 100.
string
The SIS source ID of the assignment group. This is used to integrate with Student Information Systems.
string
The integration data of the assignment group as a JSON string or plain string. Used for third-party integrations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The title for this assignment override. Required if student_ids are specified to identify the ad-hoc group.
string
The new due date for the assignment for the targeted entity (students, group, or section). Must be in ISO 8601 format.
string
The new lock date (when the assignment becomes unavailable) for the targeted entity. Must be in ISO 8601 format.
integer
The ID of the group to target with this override. All students in this group will be affected.
string
required
The ID of the course where the assignment exists and the override will be applied.
string
The new unlock date (when the assignment becomes available) for the targeted entity. Must be in ISO 8601 format.
array
A list of student IDs to target with this override. If specified, a title is also required.
string
required
The ID of the assignment for which this override is being created.
integer
The ID of the course section to target with this override. All students in this section will be affected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the course to create assignment overrides in.
array
required
Array of assignment override objects to create. All records are created in a transaction - either all succeed or none are created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_BLACKOUT_DATE_FOR_COURSETool to create a blackout date for the given course context. Use when you need to define a period during which certain activities are restricted or unavailable for a specific course.

Input Parameters

string
required
The unique identifier of the course for which to create the blackout date.
object
required
The blackout date parameters including start date, end date, and event title.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The URL that the bookmark should link to. Can be an external URL or a Canvas internal path.
string
Optional additional data/metadata associated with the bookmark. Can be used to store custom information.
string
required
The name/title of the bookmark. This is the display name that will appear in the bookmarks list.
integer
The position of the bookmark in the list. Lower numbers appear first. If not specified, defaults to the bottom of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
iCalendar Recurrence Rule (RRULE) string for recurring events (e.g., ‘FREQ=WEEKLY;BYDAY=MO,WE,FR’). Must define a finite series (include ‘UNTIL’ or ‘COUNT’).
string
Short, descriptive title for the event.
string
End date/time of the event (ISO 8601 ‘YYYY-MM-DDTHH:MM:SSZ’).
boolean
If true, event spans the entire day; start_at and end_at times are ignored (date portion only).
string
Start date/time of the event (ISO 8601 ‘YYYY-MM-DDTHH:MM:SSZ’).
object
Settings for creating a series of identical events. See DuplicateSettings.
string
Detailed description; HTML allowed for rich formatting.
string
required
Context code for the calendar, e.g., ‘course_123’ (course), ‘group_456’ (group), ‘user_789’ (user), or ‘account_1’ (account).
boolean
If true, marks a blackout date not considered in course pacing calculations.
string
Name of the event’s location (e.g., ‘Conference Room A’, ‘Online’).
object
Section-specific start/end times. Keys are arbitrary identifiers; values are ChildEventData objects.
string
Physical address of the event’s location.
string
Time zone for event creation/editing (IANA Time Zone Database or Rails TimeZone format, e.g., ‘America/New_York’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_COMMUNICATION_CHANNELCreates a new communication channel (e.g., email, SMS, push) for an existing Canvas user to receive notifications.

Input Parameters

string ("email" | "sms" | "push")
required
The type of communication channel to create. Must be one of: ‘email’, ‘sms’, or ‘push’.
string
A registration ID, device token, or equivalent token given to an app when registering with a push notification provider. Required only when ‘type’ is ‘push’. Not applicable for ‘email’ or ‘sms’ types.
string
required
The address of the communication channel. For ‘email’ type, this is an email address. For ‘sms’ type, this is a phone number in E.164 format (e.g., +15551234567).
string
required
The ID of the Canvas user for whom this communication channel will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_CONTENT_SHAREShares a Canvas content item to specified users, if the sender has necessary permissions and receiver IDs are valid.

Input Parameters

string
required
ID of the user initiating the share; ‘self’ can be used for the authenticated user.
string
required
Unique numerical identifier of the content item to be shared.
string ("assignment" | "discussion_topic" | "page" | "quiz" | "module" | "module_item")
required
Type of content being shared.
array
required
List of unique Canvas user IDs for recipients; must not be empty.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The content of the message to be sent.
string ("sync" | "async")
Determines whether messages will be created/sent synchronously or asynchronously. ‘sync’ means the action waits for completion, ‘async’ means it returns immediately. Defaults to ‘sync’.
string ("unread" | "starred" | "archived")
Filters conversations by a specific scope (e.g., ‘unread’, ‘starred’, ‘archived’) to potentially reuse an existing conversation matching this scope and other filter criteria. Affects which conversation is returned or updated if not forcing new.
array
Array of conversation IDs or user IDs. Used with 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.
string
The subject of the conversation. Maximum length is 255 characters.
boolean
If true, forces the creation of a new conversation, even if an existing private conversation with the same recipients, scope, and filters is found. If false or not provided, an existing matching conversation may be reused.
array
required
Array of recipient IDs. User IDs are numeric strings. Course/group IDs are strings prefixed with ‘course_’ or ‘group_’ respectively, followed by the ID (e.g., ‘course_123’, ‘group_456’).
string ("and" | "or" | "default")
Specifies how the filter criteria are combined (‘and’, ‘or’). Used in conjunction with scope and filter to identify an existing conversation for reuse. ‘default’ typically implies ‘and’.
string
The course or group ID that provides context for this conversation (e.g., ‘course_123’, ‘group_456’). This associates the conversation with a specific course or group.
array
Array of attachment IDs from the sender’s conversation attachments folder. These are IDs of files previously uploaded by the sender.
string
Media comment ID of an audio or video file to be associated with this message. This ID refers to a media object previously created.
boolean
If true, a single group conversation is created with all recipients. If false or not provided, individual private conversations will be created with each recipient. Ignored if force_new is true and a new conversation is created.
string ("audio" | "video")
Type of the associated media file. Must be ‘audio’ or ‘video’ if media_comment_id is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The content of the message to be sent in the conversation.
string
The subject line of the conversation. Maximum length is 255 characters.
array
required
Array of recipient user IDs as strings. These are the users who will receive the conversation message.
string
The course or group ID that provides context for this conversation (e.g., ‘course_123’, ‘group_456’).
array
Array of attachment IDs to include with the conversation. These are IDs of files previously uploaded.
string
ID of an existing conversation to reply to. If provided, adds this message to the existing conversation thread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The name of the course. If omitted, Canvas will default to ‘Unnamed Course’.
boolean
If true, the course will be made available to students (published) immediately upon creation. If false, it remains unpublished and hidden from students until explicitly published.
string
The end date and time for the course, in ISO8601 format (e.g., ‘2024-12-15T23:59:59Z’). If omitted, the course will not have a specific end date.
string ("private" | "cc_by_nc_nd" | "cc_by_nc_sa" | "cc_by_nc" | "cc_by_nd" | "cc_by_sa" | "cc_by" | "public_domain")
Specifies the license for the course content.
string
The unique identifier of the academic term (e.g., Fall 2024) to associate this course with.
string
The start date and time for the course, in ISO8601 format (e.g., ‘2024-09-01T00:00:00Z’). If omitted, the course will not have a specific start date.
boolean
If true, the user making this API request will be automatically enrolled in the newly created course as a teacher. Omitting this leaves the creator without teacher access, causing permission errors on subsequent course operations.
boolean
If set to true, the course will be publicly visible to both authenticated and unauthenticated users. Otherwise, visibility is restricted.
string
The time zone for the course, used for displaying deadlines and scheduling events. Accepts IANA time zone names (e.g., ‘America/New_York’) or Rails time zone names.
string
required
The ID of the account in which the course will be created. This is a mandatory field.
string
The course code or abbreviation (e.g., ‘CS101’, ‘HIST-202’).
string ("feed" | "wiki" | "modules" | "syllabus" | "assignments")
The default landing page for the course after a user navigates to it.
string ("on_campus" | "online" | "blended")
The delivery format of the course.
boolean
If true, all grades for assignments must be manually posted by an instructor before they are visible to students. This enables the ‘manual grading policy’ feature for the course.
string
A unique identifier for the course from an external Student Information System (SIS). Used for synchronization.
string
The HTML content for the course’s syllabus page. This can include text, images, links, and other rich content.
string
A unique identifier for the course from an external integration or third-party tool.
boolean
If set to true, the course allows open enrollment, meaning users can join without an invitation or instructor approval.
boolean
If set to true, the course syllabus will be publicly visible to all users, including those not logged in.
boolean
If set to true, students can self-enroll in the course, potentially using a join code or public course listing.
boolean
If set to true, the totals in the student grades summary page will be hidden from students, preventing them from seeing their final calculated grade.
string
A short, publicly visible description or summary of the course.
boolean
If set to true, course members (students and instructors) will be able to add comments to wiki pages.
integer
The ID of an existing grading standard to be used for the course. This defines the mapping from percentage scores to letter grades (e.g., A, B, C).
string
Configures how grades are passed back to an external system, typically an SIS. Valid options are ‘nightly_sync’ (grades sync daily), ‘disabled’ (no grade passback), or an empty string (often defaults to ‘disabled’).
boolean
If true, and a course with the same 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.
boolean
If set to true, the course is publicly visible only to authenticated users on the platform.
boolean
If set to true, the course syllabus will be visible to any authenticated user on the platform, even if they are not enrolled.
boolean
If set to true, students enrolled in the course will be able to edit and contribute to course wiki pages.
boolean
If set to true, the final grade for the course will be calculated based on weighted assignment groups (e.g., Homework 30%, Exams 70%).
boolean
If set to true, students can attach files to their posts in course discussion forums and announcements.
boolean
If set to true, student enrollments will be active only between the course’s start_at and end_at dates. Access outside these dates may be restricted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The title/name for the grading standard
string
required
The ID of the course in which to create the grading standard
boolean
Whether this grading scheme is points-based (true) or percentage-based (false). Defaults to false if not specified.
integer
For points-based schemes, the maximum number of points possible. This is the factor by which percentages are scaled. Not required for percentage-based schemes.
array
required
List of grading scheme entries defining the grading scale. Each entry has a name and minimum percentage value. Entries should be ordered from highest to lowest value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The title/header text for the custom gradebook column.
boolean
If true, the column will not be displayed in the gradebook. Defaults to false.
integer
The position of the column relative to other custom columns. Lower numbers appear first.
string
required
The unique identifier of the course where the custom gradebook column will be created.
boolean
If true, the column will not be editable in the gradebook UI. Defaults to false.
boolean
If true, this column is designated as a teacher notes column. The gradebook only supports one teacher_notes column.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_DISCUSSION_ENTRYTool to create a new entry in a Canvas discussion topic. Use when posting a message with optional attachments to a discussion topic.

Input Parameters

string
required
The content of the discussion entry. Supports HTML formatting.
string
required
The unique identifier of the discussion topic within the course.
string
required
The unique identifier of the Canvas course.
array
A list of file attachment IDs to include with the new entry, if any.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_DISCUSSION_ENTRY_GRAPH_QLTool to create a new entry in a Canvas discussion topic via GraphQL. Use when posting a message or reply to a discussion topic with optional file attachments.

Input Parameters

string
Optional file attachment ID to include with the entry.
string
required
The content/text of the discussion entry.
string
ID of parent entry if this is a reply to another entry.
string
ID of entry being quoted in this post.
string
required
The ID of the discussion topic to post to.
boolean
Whether to post anonymously. If true, the author’s identity will be hidden.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The title of the new discussion topic.
boolean
Set to true to pin the topic, listing it in a ‘Pinned Discussions’ section for higher visibility. Defaults to false.
string
The datetime (ISO 8601 format) when the topic should be automatically locked, preventing further replies. If omitted, the topic will not automatically lock.
string
The main content/message of the discussion topic. Supports HTML for rich content formatting. If omitted, the discussion topic will have no initial message.
string
required
The unique identifier for the course where the discussion topic will be created.
boolean
Set to true to publish the topic immediately, or false to save it as a draft. Defaults to false if not provided, creating a draft.
boolean
Set to true to allow users to rate entries in this topic. Defaults to false.
string
The ID of another discussion topic within the same course. If provided, this new topic will be positioned immediately after the specified topic in the discussion list.
boolean
If allow_rating is true, set this to true to sort discussion entries by their ratings. Defaults to false.
string
The datetime (ISO 8601 format) when the topic should be automatically published. If set, published should ideally be false or omitted.
string
The type of discussion. Accepted values: ‘side_comment’ (allows replies to any message), ‘threaded’ (allows threaded replies), ‘not_threaded’ (linear discussion). Defaults to ‘threaded’ if not specified.
boolean
Set to true to mark this topic as an announcement. Announcements may appear in a special section or have different notification behavior. Defaults to false.
boolean
Set to true to enable an associated podcast feed for this topic. Defaults to false.
integer
The ID of a group category within the course. If provided, the discussion topic will be associated with this group category, potentially creating group-specific discussions or restricting access. Example: A group discussion.
string
A comma-separated string of section IDs to which this discussion topic should be restricted. If omitted, or an empty string is provided, the topic is available to all sections in the course.
boolean
Set to true to require users to make an initial post before they can view other replies in the topic. Defaults to false.
boolean
If 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).
boolean
If podcast_enabled is true, set this to true to include student posts in the podcast feed. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Title of the discussion topic.
string
Message/content of the discussion topic. Can include HTML formatting.
boolean
Whether the discussion topic should be published immediately. Set to true to publish, false to save as draft.
string
required
The ID of the context (course or group) where the discussion topic will be created.
string ("Course" | "Group")
required
The type of context - either Course or Group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
ISO8601 end date/time for enrollment. If unspecified, may follow course/term dates or be indefinite.
boolean
If true, sends notification to user. Default notification behavior varies if null/false.
integer
ID of a custom course-level role, potentially overriding enrollment_type.
string
required
The ID of the user to be enrolled in the course.
string
ISO8601 start date/time for enrollment. If unspecified, may start immediately or align with course/term settings.
string
required
The ID of the course in which to enroll the user.
string
SIS (Student Information System) ID for the user; an alternative identifier.
boolean
True if self-initiated enrollment, typically with self_enrollment_code.
string
External unique identifier for linking with third-party systems.
string ("StudentEnrollment" | "TeacherEnrollment" | "TaEnrollment" | "ObserverEnrollment" | "DesignerEnrollment")
Enrollment type determining role/permissions. Canvas defaults to ‘StudentEnrollment’ if unspecified.
string ("active" | "invited" | "inactive")
State of enrollment: ‘active’, ‘invited’ (requires user acceptance), or ‘inactive’.
integer
ID of a specific course section for enrollment. If omitted, user enrolls in the course generally.
integer
For ‘ObserverEnrollment’, the ID of the student to be observed.
string
Code for self-enrollment if self_enrolled is true.
boolean
If true, confines user access to course_section_id (requires course_section_id to be set).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_EPUB_EXPORTTool to initiate an ePub export for a course. Use when you need to export course content in ePub format. Track progress using the Progress API URL returned in the response.

Input Parameters

string
required
The unique identifier for the course. Can be a numeric ID or SIS ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The URL to the external RSS or Atom feed to be imported into the course.
string
required
The ID of the course for which to create the external feed.
string ("full" | "truncate" | "link_only")
Controls how much of the feed content is displayed. Defaults to ‘full’ if not specified. ‘full’ shows complete entries, ‘truncate’ shows shortened versions, ‘link_only’ shows only links.
string
If provided, only feed entries that contain this string in their title will be imported. Leave empty to import all entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The URL to the external RSS or Atom feed to be imported into the group.
string
required
The ID of the group for which to create the external feed.
string ("full" | "truncate" | "link_only")
Controls how much of the feed content is displayed. Defaults to ‘full’ if not specified. ‘full’ shows complete entries, ‘truncate’ shows shortened versions, ‘link_only’ shows only links.
string
If provided, only feed entries that contain this string in their title will be imported. Leave empty to import all entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The URL to match links against. Either ‘url’ or ‘domain’ should be set, not both.
string
The name of the external tool. This parameter overrides the tool name provided in XML configuration if config_type is set.
string
The default text to show for this tool.
string
The domain to match links against (without protocol/port). Either ‘url’ or ‘domain’ should be set, not both.
string
The URL of the icon to show for this tool.
string
The client ID attached to the developer key. If supplied, all other parameters are unnecessary and will be ignored. Used for LTI 1.3 standard.
string
required
The unique identifier of the account where the external tool will be created.
string
URL where the server can retrieve an XML tool configuration. Required if config_type is ‘by_url’.
string
XML tool configuration, as specified in the Common Cartridge XML specification. Required if config_type is ‘by_xml’.
string ("by_url" | "by_xml")
Configuration type for external tool.
string
A description of the tool.
string
The consumer key for the external tool (OAuth 1.0).
object
Custom fields that will be sent to the tool consumer. Use key-value pairs.
string ("anonymous" | "name_only" | "email_only" | "public")
Privacy level for external tool - how much user information to send.
string
The shared secret with the external tool (OAuth 1.0).
boolean
If set to true, and resource_selection is false, the tool won’t show up in the external tool selection UI in modules and assignments. Default: false.
boolean
(Deprecated) Whether this tool should appear in a preferred location in the Rich Content Editor. Only applies to tools in root account contexts with an editor button placement.
boolean
If set to true, LTI query params will not be copied to the post body. Default: false.
string
The unique identifier for the tool in LearnPlatform.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The URL to match links against. Either ‘url’ or ‘domain’ should be set, not both.
string
The name of the external tool. This parameter overrides the tool name provided in XML configuration if config_type is set.
string
The default text to show for this tool.
string
The domain to match links against (without protocol/port). Either ‘url’ or ‘domain’ should be set, not both.
string
The URL of the icon to show for this tool.
string
The client ID attached to the developer key. If supplied, all other parameters are unnecessary and will be ignored. Canvas will attempt to create a context external tool using the LTI 1.3 standard.
string
required
The unique identifier of the course where the external tool will be created.
string
URL where the server can retrieve an XML tool configuration. Required if config_type is ‘by_url’.
string
XML tool configuration, as specified in the Common Cartridge XML specification. Required if config_type is ‘by_xml’.
string ("by_url" | "by_xml")
Configuration type for external tool.
string
A description of the tool.
string
The consumer key for the external tool (OAuth 1.0).
object
Custom fields that will be sent to the tool consumer. Use key-value pairs.
string ("anonymous" | "name_only" | "email_only" | "public")
Privacy level for external tool - how much user information to send.
string
The shared secret with the external tool (OAuth 1.0).
boolean
If set to true, and resource_selection is false, the tool won’t show up in the external tool selection UI in modules and assignments. Default: false.
boolean
(Deprecated) Whether this tool should appear in a preferred location in the Rich Content Editor. Only applies to tools in root account contexts with an editor button placement.
boolean
If set to true, LTI query params will not be copied to the post body. Default: false.
string
The unique identifier for the tool in LearnPlatform.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the file being uploaded. Any UTF-8 name is allowed. Path separators such as ’/’ and ” will be treated as part of the filename, not as path elements.
integer
The size of the file in bytes. This field is recommended as it will allow you to catch quota issues before uploading the raw file data.
string
required
The unique identifier of the context entity (e.g., course ID, user ID, folder ID, group ID, or account ID) where the file will be created.
string
The content type (MIME type) of the file. If not provided, it will be guessed based on the file extension.
string ("courses" | "users" | "folders" | "groups" | "accounts")
required
The context in which to create the file. Valid contexts are ‘courses’, ‘users’, ‘folders’, ‘groups’, or ‘accounts’.
string ("overwrite" | "rename")
How to handle duplicate filenames. If ‘overwrite’ (default), the existing file will be overwritten. If ‘rename’, the new file will be renamed to avoid conflicts.
string
The ID of the folder to store the file in. If not provided and the context is not a folder, the file will be stored in the root folder of the context. If this parameter is passed and refers to a non-existent folder, the API returns an error.
string
The path of the folder to store the file in. The path separator is forward slash (/), e.g., ‘course files/week 1’. If this parameter is passed and the folder does not yet exist, it will be created automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the folder.
boolean
Flag the folder as hidden.
boolean
Flag the folder as locked.
string
The datetime to lock the folder at in ISO 8601 format.
string
required
The ID of the user to create the folder for. Use ‘self’ for the authenticated user.
integer
Set an explicit sort position for the folder.
string
The datetime to unlock the folder at in ISO 8601 format.
string
The id of the folder to store the new folder in. An error will be returned if this does not correspond to an existing folder. If this and parent_folder_path are sent an error will be returned. If neither is given, a default folder will be used.
string
The path of the folder to store the new folder in. The path separator is the forward slash /, 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the folder to create.
boolean
Flag the folder as hidden.
boolean
Flag the folder as locked.
string
The datetime to lock the folder at (ISO 8601 format, e.g., ‘2011-10-21T18:48Z’).
string
required
The unique identifier of the group where the folder will be created.
integer
Set an explicit sort position for the folder.
string
The datetime to unlock the folder at (ISO 8601 format, e.g., ‘2011-10-21T18:48Z’).
string
The id of the folder to store the new folder in. An error will be returned if this does not correspond to an existing folder. If this and parent_folder_path are sent an error will be returned. If neither is given, a default folder will be used.
string
The path of the folder to store the new folder in. The path separator is the forward slash /, 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the group.
boolean
Whether the group is public (applies only to community groups).
string ("parent_context_auto_join" | "parent_context_request" | "invitation_only")
Specifies who can join the group and how.
string
A description of the group.
string
The SIS ID of the group. Must have manage_sis permission to set.
integer
The allowed file storage for the group, in megabytes. This parameter is ignored if the caller does not have the manage_storage_quotas permission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the group category.
string
required
The ID of the course in which to create the group category.
string ("first" | "random")
Method for automatically assigning group leaders.
integer
Limit the maximum number of users in each group (Course Only). Requires self signup to be enabled.
string ("enabled" | "restricted")
Self-signup options for students in the group category.
boolean
Can only be set by users with the Differentiation Tag - Add permission. If set to true, groups in this category will be only visible to users with the Differentiation Tag - Manage permission.
string
(Deprecated) Create this number of groups, and evenly distribute students among them. Not allowed with ‘enable_self_signup’. Because the group assignment happens synchronously, it’s recommended that you instead use the assign_unassigned_members endpoint (Course Only).
integer
Create this number of groups (Course Only).
string
The unique SIS identifier for the group category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
For course_copy_importer migrations, select objects to copy without using selective_import workflow. Keys are object types (e.g., ‘files’, ‘folders’, ‘pages’), values are lists of object ids.
string
required
The unique identifier for the Canvas group where the content migration will be created.
object
Settings for content migration configuration.
string ("canvas_cartridge_importer" | "common_cartridge_importer" | "course_copy_importer" | "zip_file_importer" | "qti_converter" | "moodle_converter")
required
The type of the migration. Use the Migrator endpoint to see all available migrators.
object
Parameters for pre-uploading a file for content migration.
boolean
If true, perform a selective import instead of importing all content. The migration will identify contents and stop in ‘waiting_for_select’ state. Use the List items endpoint to enumerate contents, then call the Update endpoint with copy parameters to start import.
object
Date shifting options for migrated content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The title of the new discussion topic.
boolean
If true, this topic will be listed in the ‘Pinned Discussion’ section.
string
If a timestamp is given, the topic will be scheduled to lock at the provided timestamp. If the timestamp is in the past, the topic will be locked.
string
The main content/message of the discussion topic. Supports HTML for rich content formatting.
boolean
If true, thread will be expanded by default.
string
required
The unique identifier for the group where the discussion topic will be created.
boolean
Whether this topic is published (true) or draft state (false). Only teachers and TAs have the ability to create draft state topics.
string
To create an assignment discussion, pass the assignment parameters as a sub-object. See the Create an Assignment API for the available parameters.
string
A multipart/form-data form-field-style attachment. Attachments larger than 1 kilobyte are subject to quota restrictions.
string ("asc" | "desc")
Sort order for discussion entries.
boolean
Whether or not users can rate entries in this topic.
boolean
If is_announcement and lock_comment are true, ‘Allow Participants to Comment’ setting is disabled.
string
By default, discussions are sorted chronologically by creation date. Pass the id of another topic to have this one show up after the other when they are listed.
boolean
(DEPRECATED) If true, entries will be sorted by rating.
string
If a timestamp is given, the topic will not be published until that time.
string ("side_comment" | "threaded" | "not_threaded")
Type of discussion threading.
boolean
If true, users cannot choose their preferred thread expansion setting.
boolean
If true, this topic is an announcement. It will appear in the announcement’s section rather than the discussions section.
boolean
If true, the topic will have an associated podcast feed.
string
If present, the topic will become a group discussion assigned to the group.
boolean
If true, users cannot choose their preferred sort order.
string
A comma-separated list of sections ids to which the discussion topic should be made specific to. Can only be present only on announcements and only those that are for a course (as opposed to a group).
boolean
If true then a user may not respond to other replies until that user has made an initial reply. Defaults to false.
boolean
If true, only graders will be allowed to rate entries.
boolean
If true, the podcast will include posts from students as well. Implies podcast_enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_GROUP_IN_SETTool to create a new group within a Canvas group set. Use when adding a new group to an existing group category.

Input Parameters

string
required
The name of the group to create.
string
required
The ID of the group set (group category) to create the group in.
boolean
Whether the group should be non-collaborative (defaults to false if not provided).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_GROUP_SETCreates a group set (group category) in a Canvas course or account. Check the returned result for the created group set; top-level GraphQL errors may result in a response without it.

Input Parameters

string
required
The name of the group set.
string
required
The ID of the context (course or account) where the group set will be created.
integer
Maximum number of members allowed per group.
boolean
If true, enables self-signup for groups.
boolean
If true, assigns students to groups asynchronously.
string ("course" | "account")
required
The type of context for the group set.
string ("first" | "random")
Method of selecting an automatic leader for groups.
boolean
If true, restricts group membership to students within the same section.
boolean
If true, marks the group set as non-collaborative (students work independently).
integer
Number of groups to create within the group set.
boolean
If true, enables automatic leader assignment for groups.
boolean
If true, allows students to sign up for groups themselves.
boolean
If true, restricts self-signup based on additional criteria.
boolean
If true, automatically assigns unassigned members to groups.
integer
Target number of members per group when auto-creating groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The title of the learning outcome.
array
List of rating criteria for the learning outcome, each with description and points.
string
required
The ID of the outcome group where this learning outcome will be created.
string
A detailed description of the learning outcome.
string
A third-party vendor GUID for the outcome, used for external integrations.
string
A short display name for the learning outcome.
number
The number of points required to achieve mastery for this outcome.
integer
An integer parameter for the calculation method. Required for ‘decaying_average’ (weight between 1-99) and ‘n_mastery’ (number of times, minimum 1).
string ("decaying_average" | "n_mastery" | "latest" | "highest" | "average")
Calculation methods for learning outcomes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Bulk add multiple users to a group. Provide array of user IDs. Cannot be used with user_id or all_in_group_course.
string
The ID of the user for individual membership creation. Required unless using bulk options.
string
required
The unique identifier of the group to create membership in.
array
An array of user IDs to exclude when using all_in_group_course. Only applies when all_in_group_course is true.
boolean
If true, add all enrolled students from the course. Cannot be used with user_id or members.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_MODULECreates a new organizational module within a specified Canvas LMS course, with options for availability, sequencing, and prerequisites.

Input Parameters

string
required
Name for the new module.
integer
1-based position in the course’s module list.
string
required
ID of the course for the new module.
string
ISO 8601 datetime for module availability to students. If omitted, availability follows course settings.
boolean
If true, automatically publishes the student’s final course grade upon module completion.
array
List of module IDs that are prerequisites for accessing this module.
boolean
If true, students must complete items sequentially; if false, any order is allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_MODULE_GRAPH_QLTool to create a new module in a Canvas course via GraphQL. Use when creating a module with basic settings (name) through the GraphQL API.

Input Parameters

string
required
The name of the module to create.
string
required
The ID of the course to create the module in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("File" | "Page" | "Discussion" | "Assignment" | "Quiz" | "SubHeader" | "ExternalUrl" | "ExternalTool")
required
The type of content linked to the item. Determines which other fields are required.
string
required
The name of the module item and associated content.
integer
0-based indent level; module items may be indented to show a hierarchy. Defaults to 0.
boolean
Whether the external tool opens in a new tab. Only applies to ‘ExternalTool’ type.
string
Suffix for the linked wiki page (e.g. ‘front-page’). Required for ‘Page’ type.
integer
The position of this item in the module (1-based). If not specified, item is added to the end.
string
required
The unique identifier of the Canvas course containing the module.
string
required
The unique identifier of the module to add the item to.
string
The id of the content to link to the module item. Required for ‘File’, ‘Discussion’, ‘Assignment’, ‘Quiz’, and ‘ExternalTool’ types. Not required for ‘ExternalUrl’, ‘Page’, and ‘SubHeader’ types.
string
External url that the item points to. Required for ‘ExternalUrl’ and ‘ExternalTool’ types.
integer
Width of the ExternalTool on launch. Only applies to ‘ExternalTool’ type.
integer
Height of the ExternalTool on launch. Only applies to ‘ExternalTool’ type.
string ("must_view" | "must_contribute" | "must_submit" | "must_mark_done" | "min_score")
Type of completion requirement for the module item.
integer
Minimum score required to complete. Required for completion_requirement_type ‘min_score’. Only applies to Assignment and Quiz types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
An array of event objects to create or update. Each event must have start_at and end_at times.
string
required
The ID of the course for which timetable events will be created or updated.
string
Events will be created for the course section specified by course_section_id. If not present, events will be created for the entire course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
HTML content of the new page. Must be valid HTML.
string
required
Title for the new wiki page.
string
required
Unique identifier for the course.
boolean
Publish the page upon creation. Defaults to false (draft).
boolean
Set as the front page for the course; page must also be published. Defaults to false.
string
Comma-separated string of roles allowed to edit: ‘teachers’, ‘students’, ‘members’, ‘public’. Defaults to ‘teachers’.
boolean
Notify users of changes to this page. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
HTML content of the new page. Must be valid HTML.
string
required
Title for the new wiki page.
string
required
Unique identifier for the group where the page will be created.
boolean
Whether the page is published (true) or draft state (false).
boolean
Set an unhidden page as the front page (if true). Page must also be published.
string
Schedule a future date/time to publish the page in ISO 8601 format. This will have no effect unless the ‘Scheduled Page Publication’ feature is enabled in the account. If a future date is supplied, the page will be unpublished and published parameter will be ignored.
string ("teachers" | "students" | "members" | "public")
Which user roles are allowed to edit this page. Any combination of these roles is allowed (separated by commas): ‘teachers’ (allows editing by teachers), ‘students’ (allows editing by students), ‘members’ (for group wikis, allows editing by members of the group), ‘public’ (allows editing by any user).
boolean
Whether participants should be notified when this page changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The title of the planner note. If linked to a learning object and title is not provided, the planner note will use the learning object’s title.
string
Text of the planner note. Can contain HTML formatting.
integer
The ID of the course to associate with the planner note. The caller must be able to view the course in order to associate it with a planner note.
string
The date where this planner note should appear in the planner. Format: ‘yyyy-mm-dd’.
integer
The id of a learning object to link to this planner note. Must be used in conjunction with linked_object_type and course_id. If the title argument is not provided, the planner note will use the learning object’s title as its title.
string ("announcement" | "assignment" | "discussion_topic" | "wiki_page" | "quiz")
Valid types for linked learning objects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
If this is true, the item will not show in the opportunities list.
string
required
ID of the item that you are overriding in the planner.
string ("announcement" | "assignment" | "discussion_topic" | "quiz" | "wiki_page" | "planner_note" | "calendar_event" | "assessment_request" | "sub_assignment")
required
Type of the item that you are overriding in the planner.
boolean
If this is true, the item will show in the planner as completed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the quiz to create the question group for.
string
required
The ID of the course containing the quiz.
array
required
List of question groups to create. Each group specifies a name, number of questions to pick, points per question, and optionally a question bank to pull from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The title of the quiz.
string
The date and time (ISO 8601 format) by which the quiz should be submitted.
string
The date and time (ISO 8601 format) after which students can no longer submit the quiz.
string
required
The ID of the course where the quiz will be created.
string
An optional comma-separated list of IP addresses or CIDR ranges (e.g., ‘192.168.1.0/24’, ‘203.0.113.42’) to restrict quiz access.
boolean
If true, the quiz will be published and visible to students according to availability dates and override settings. Default is typically false for new quizzes.
string ("practice_quiz" | "assignment" | "graded_survey" | "survey")
Specifies the type of quiz: ‘practice_quiz’ (ungraded practice), ‘assignment’ (graded quiz), ‘graded_survey’ (graded but no correct answers), or ‘survey’ (ungraded, no correct answers). Defaults to ‘assignment’ if omitted.
string
The date and time (ISO 8601 format) when the quiz becomes available for students to take.
integer
The time limit for the quiz in minutes. Use null or omit for no time limit.
string
An optional password students must enter to start the quiz.
string
A textual description of the quiz content and instructions.
boolean
If true and 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.
string ("always" | "until_after_last_attempt")
Controls when students can see their quiz results. If null or omitted, results are shown immediately after submission.
string ("keep_highest" | "keep_latest")
If multiple attempts are allowed, this determines which attempt’s score is recorded.
boolean
If true, the order of answers for questions will be randomized for each student. Default is typically false.
integer
The number of times a student is allowed to take the quiz. Use -1 for unlimited attempts. Omit for course/quiz default.
boolean
If true and 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.
integer
The ID of the assignment group to associate the quiz with. This is applicable only if the quiz is graded (e.g., ‘assignment’ or ‘graded_survey’ type).
boolean
If true, students will be able to see the correct answers when viewing their results (subject to other settings like show_correct_answers_at and hide_correct_answers_at). Default is typically true.
boolean
If true, students will see one question at a time and must navigate sequentially. Default is false.
string
The date and time (ISO 8601 format) after which correct answers will be hidden from students. Requires show_correct_answers to be true.
string
The date and time (ISO 8601 format) when correct answers will become visible to students. Requires show_correct_answers to be true.
boolean
If true, the quiz is hidden from the general student population and only accessible to students with specific assignment overrides. Default is false.
boolean
If true, correct answers will only be shown to students after their last allowed attempt. Requires show_correct_answers to be true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Array of Answer objects. Structure must align with 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.
string
required
Identifier of the quiz to add the question to.
integer
1-based display order in the quiz; defaults to end if omitted.
string
required
Identifier of the course containing the quiz.
string
required
Descriptive name for identification, especially in question banks.
string
required
Main question content, presented to the student; supports HTML.
string ("calculated_question" | "essay_question" | "file_upload_question" | "fill_in_multiple_blanks_question" | "matching_question" | "multiple_answers_question" | "multiple_choice_question" | "multiple_dropdowns_question" | "numerical_question" | "short_answer_question" | "text_only_question" | "true_false_question")
required
Question format and answer options. See QuestionType enum.
integer
ID of an existing quiz group for this question; for organization within the quiz.
integer
Maximum points for a correct answer.
string
Feedback (text/HTML) for a correct answer.
string
Feedback (text/HTML) regardless of answer correctness.
string
Feedback (text/HTML) for an incorrect answer.
string
Additional text/HTML displayed post-submission (e.g., explanations).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("file" | "progress")
Whether the output should include documents for the ‘file’ and/or ‘progress’ objects associated with this report. Only applicable with JSON-API formatted responses.
string
required
The ID of the quiz for which to generate a report.
string
required
The ID of the course containing the quiz.
string ("student_analysis" | "item_analysis")
required
The type of report to generate. ‘student_analysis’ provides detailed student performance data, while ‘item_analysis’ focuses on question-level statistics.
boolean
Whether the report should consider all quiz submission attempts or only the most recent attempt for each student. Defaults to false (most recent only). Ignored for ‘item_analysis’ reports.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether this should be a preview quiz submission and not count towards the user’s course record. Teachers only.
string
required
The unique ID of the quiz.
string
required
The unique ID of the course.
string
Access code for the quiz, if the quiz requires one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_RUBRICTool to create a rubric in a Canvas course. Use when you need structured assessment criteria and optional association after confirming course context.

Input Parameters

object
required
Rubric data to create
string
required
The ID of the course in which to create the rubric
object
Optional association settings linking rubric to an assignment, course, or account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The title of the poll. This is the main question that will be displayed to poll participants.
string
A brief description or instructions for the poll. Provides additional context for participants.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_SINGLE_POLL_CHOICETool to create one or more poll choices for an existing poll in Canvas. Use when you need to add answer options to a poll.

Input Parameters

string
required
The ID of the poll to add the choice to.
array
required
Array of poll choice objects to create. Typically contains one poll choice, but the API accepts multiple.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_SINGLE_POLL_SESSIONTool to create a new poll session for a poll in Canvas. Use when you need to create a poll session associated with a specific course or course section.

Input Parameters

string
required
The unique identifier of the poll to create a session for.
integer
required
The id of the course this session is associated with.
integer
The id of the course section this session is associated with.
boolean
Whether or not results are viewable by students.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the poll.
array
required
List of poll choice IDs to submit. Each ID represents a selected choice for this poll submission.
string
required
The unique identifier of the poll session. The poll session must be published before submissions can be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the parent outcome group under which the subgroup will be created.
string
required
The title of the new outcome subgroup.
string
required
The unique identifier of the course that owns the parent outcome group.
string
The description of the new outcome subgroup.
string
A custom GUID for the learning standard. Used for external integrations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
URL for online_url submissions. Required when activeSubmissionType is ‘online_url’.
string
The body text for online_text_entry submissions. Required when activeSubmissionType is ‘online_text_entry’.
integer
The attempt number for this draft submission. If not provided, uses the next attempt number.
array
Array of file IDs for online_upload submissions. Required when activeSubmissionType is ‘online_upload’.
string
Media ID for media_recording submissions. Required when activeSubmissionType is ‘media_recording’.
string
LTI launch URL for basic_lti_launch submissions. Used with externalToolId.
string
required
The ID of the submission to create a draft for. This is a required field.
string
External tool ID for basic_lti_launch submissions. Required when activeSubmissionType is ‘basic_lti_launch’.
string ("basic_lti_launch" | "media_recording" | "online_text_entry" | "online_upload" | "online_url" | "student_annotation")
required
The type of submission draft to create. Must be one of the supported submission types.
Resource link lookup UUID for LTI submissions. Used for LTI 1.3 resource link identification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_CREATE_USER_INBOX_LABELTool to create new user inbox labels in Canvas. Use when organizing inbox messages with custom labels.

Input Parameters

array
required
A list of label names to create for the user’s inbox. Each name should be a non-empty string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Namespace parameter (required) to prevent custom_data collisions between different applications. Should use reverse DNS format like ‘com.organization.app’.
object
required
The custom data to store (JSON object, can be nested). This will replace any existing data at the root level of the namespace.
string
The user ID. Use ‘self’ for the authenticated user, or provide a specific user ID (requires admin permissions).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
The scopes to associate with the token. Ignored if the default developer key does not have the ‘enable scopes’ option enabled. In such cases, the token will inherit the user’s permissions instead.
string
required
The purpose of the token. This is a required field that describes what the token will be used for.
string
The ID of the user to create a token for. Use ‘self’ to create a token for the currently authenticated user, or provide a specific user ID.
string
The time at which the token will expire, in ISO 8601 format (e.g., ‘2024-12-31T23:59:59Z’). If omitted, the token will not have an expiration date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the access token to delete. Can be the actual database ID of the token, or the ‘token_hint’ value.
string
required
The ID of the user whose token to delete. Use ‘self’ for the currently authenticated user, or provide a specific user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the conversation from which to delete messages.
array
required
Array of message IDs to be deleted from the conversation. Note that this only affects this user’s view of the conversation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the discussion entry to delete. The entry must have been created by the current user, or the current user must have admin rights to the discussion.
string
required
The unique identifier of the discussion topic containing the entry.
string
required
The unique identifier of the course containing the discussion topic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the discussion entry to delete. The entry must have been created by the current user, or the current user must have admin rights to the discussion.
string
required
The unique identifier of the group containing the discussion topic.
string
required
The unique identifier of the discussion topic containing the entry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_AN_EXTERNAL_TOOLRemove the specified external tool from a course. Use when you need to delete an external tool integration.

Input Parameters

string
required
The unique identifier of the course containing the external tool.
string
required
The unique identifier of the external tool to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the outcome group to delete. Deleting this group will also delete all descendant outcome groups and outcome links.
string
required
The unique identifier of the course containing the outcome group to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_APPOINTMENT_GROUPPermanently deletes an existing appointment group by its ID; associated appointments may also be canceled or affected.

Input Parameters

string
An optional reason for deleting the appointment group.
string
required
The unique identifier of the appointment group to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_ASSIGNMENTSoft-deletes a specific assignment within a course, returning the assignment object with its workflow_state updated to ‘deleted’.

Input Parameters

integer
required
The unique identifier of the course to which the assignment belongs.
integer
required
The unique identifier of the assignment to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_ASSIGNMENT_OVERRIDEDeletes an assignment override and returns its former details. Use when you need to remove date exceptions or special accommodations that were previously set for specific students, groups, or sections.

Input Parameters

string
required
The unique identifier of the assignment override to delete.
string
required
The unique identifier of the course containing the assignment.
string
required
The unique identifier of the assignment containing the override.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_BLACKOUT_DATETool to delete a blackout date for the given course context. Use when you need to remove a previously scheduled blackout period.

Input Parameters

string
required
The unique identifier of the blackout date to be deleted.
string
required
The unique identifier of the course that contains the blackout date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_BOOKMARKDeletes a bookmark from the current user’s bookmarks. Use when you need to remove a saved bookmark.

Input Parameters

string
required
The unique identifier of the bookmark to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_CALENDAR_EVENTDeletes a Canvas calendar event and returns its details. For recurring events, the deletion can cover the selected event, the entire series, or the selected event and following events; an optional cancellation reason can be provided.

Input Parameters

string
required
The unique identifier of the calendar event to be deleted.
string ("one" | "all" | "following")
Defines the scope of deletion for recurring calendar events.
string
Reason for deleting or canceling the event. This will be visible to event participants.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the comment bank item to delete. This should be a GraphQL global ID (e.g., ‘Q29tbWVudEJhbmtJdGVtLTI=’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the communication channel to delete.
string
required
The ID of the user who owns the communication channel. Use ‘self’ for the current user, a numeric user ID, or a SIS User ID prefixed with ‘sis_user_id:’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("email" | "sms" | "push")
required
The type of communication channel to delete. Must be one of: ‘email’, ‘sms’, or ‘push’.
string
required
The address of the communication channel to delete. For ‘email’ type, this is an email address. For ‘sms’ type, this is a phone number in E.164 format (e.g., +15551234567).
string
required
The ID of the Canvas user who owns the communication channel. Use ‘self’ for the current user, a numeric user ID, or a SIS User ID prefixed with ‘sis_user_id:’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of conversation message IDs to delete. Each ID should be a string representing the unique identifier of a message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_CONVERSATIONSTool to delete one or more Canvas conversations. Use when permanently removing conversation threads. Returns the deleted conversation IDs on success.

Input Parameters

array
required
Array of conversation IDs to delete. Each ID should be a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_CUSTOM_DATADeletes all custom user data in a specified namespace for a user.

Input Parameters

string
required
The namespace from which to delete the data. This should be something other Canvas API apps aren’t likely to use, such as a reverse DNS for your organization (e.g., ‘com.composio.test’).
string
required
The unique identifier of the user whose custom data should be deleted. Use ‘self’ to refer to the current authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_CUSTOM_GRADEBOOK_COLUMNPermanently deletes a custom gradebook column and its associated data from a course. This action cannot be undone.

Input Parameters

string
required
The unique identifier of the custom gradebook column to be deleted.
string
required
The unique identifier of the course containing the custom gradebook column.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_CUSTOM_GRADE_STATUSTool to delete a custom grade status from Canvas. Use when removing a custom grade status that is no longer needed.

Input Parameters

string
required
The ID of the custom grade status to delete. Use the legacy ID format (e.g., ‘1’, ‘2’) not GraphQL global ID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_DISCUSSION_ENTRYDeletes a Canvas discussion entry via GraphQL. The mutation requests the deleted entry’s ID and any validation errors.

Input Parameters

string
required
The unique identifier of the discussion entry to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_DISCUSSION_TOPIC_GRAPH_QLTool to delete a discussion topic in Canvas via GraphQL. Returns the deleted discussion topic ID upon successful deletion.

Input Parameters

string
required
The unique identifier of the discussion topic to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_EXTERNAL_FEED_FROM_GROUPDeletes the external feed from the specified group. Use when removing an RSS/Atom feed that was previously configured for the group.

Input Parameters

string
required
The unique identifier of the group containing the external feed.
string
required
The unique identifier of the external feed to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the file to be deleted.
boolean
If true, the file contents will be replaced with a generic ‘file has been removed’ file and any previews will be destroyed. This action is irreversible. Must have ‘manage files and become other users’ permissions to use this option.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_FOLDERPermanently deletes an existing folder specified by its unique ID.

Input Parameters

string
required
Unique identifier of the folder to be deleted.
boolean
If true, deletes the folder even if it contains items. If false (default), the folder must be empty for deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_GROUPDeletes a group and removes all members. Use when you need to permanently delete a Canvas group by its ID.

Input Parameters

string
required
The unique identifier of the group to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_GROUP_DISCUSSION_TOPICDeletes the discussion topic from a group. This will also delete the assignment, if it’s an assignment discussion.

Input Parameters

string
required
The unique identifier of the group containing the discussion topic.
string
required
The unique identifier of the discussion topic to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the group containing the wiki page.
string
required
The URL (e.g., ‘test-page-for-deletion’) or the numeric ID of the page to delete. If a page URL might be identical to another page’s numeric ID, prefix the ID with ‘page_id:’ (e.g., ‘page_id:5678’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_PLANNER_NOTEDelete a planner note for the current user. Use when removing a personal to-do item from the Canvas planner.

Input Parameters

string
required
The unique identifier of the planner note to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_PLANNER_OVERRIDEDelete a planner override for the current user. Use when removing customizations or dismissals from planner items.

Input Parameters

string
required
The unique identifier of the planner override to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_POLLDeletes the poll identified by its ID and returns a success flag when the request succeeds.

Input Parameters

string
required
The unique identifier of the poll to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_POLL_CHOICEDeletes a specific poll choice from a Canvas poll. Returns a success flag and message when the deletion request succeeds.

Input Parameters

string
required
The unique identifier of the poll choice to be deleted.
string
required
The unique identifier of the poll containing the poll choice to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_POLL_SESSIONDeletes a poll session from a Canvas poll. Returns a success flag and message when the deletion request succeeds.

Input Parameters

string
required
The unique identifier of the poll session to be deleted.
string
required
The unique identifier of the poll containing the poll session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_QUIZPermanently deletes the quiz identified by quiz_id from the course identified by course_id; this action cannot be undone.

Input Parameters

string
required
The unique identifier for the quiz to be deleted.
string
required
The unique identifier for the course from which the quiz will be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_SUBMISSION_DRAFTTool to delete a submission draft in Canvas via GraphQL. Use when removing a draft submission that has not been finalized.

Input Parameters

string
required
The ID of the submission draft to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DELETE_USER_INBOX_LABELTool to delete user inbox labels in Canvas. Use when you need to remove one or more custom inbox labels from the current user’s inbox.

Input Parameters

array
required
Array of inbox label names to delete. Each name must be a string representing an existing user inbox label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The namespace from which to delete the data. This should be something other Canvas API apps aren’t likely to use, such as a reverse DNS for your organization (e.g., ‘com.composio.test’).
string
required
The scope path for the custom data to delete (e.g., ‘test/composio’ or ‘fruit/kiwi’). This defines the specific location in the JSON data structure to delete.
string
required
The unique identifier of the user whose custom data should be deleted. Use ‘self’ to refer to the current authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DEPARTMENT_LEVEL_GRADE_DATA_FOR_CURRENT_GRADESFetches current, aggregated grade data from Canvas analytics for a specified account ID.

Input Parameters

string
required
Unique Canvas account ID (often a department or sub-account) for which to retrieve current grade analytics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DEPARTMENT_LEVEL_GRADE_DATA_FOR_TERM_GRADESRetrieves department-level aggregated grade data for a specific academic term within a Canvas account.

Input Parameters

string
required
Unique identifier for the academic term to request grade data for.
string
required
Unique identifier for the Canvas account to retrieve analytics data from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The content of the entry or reply. Supports HTML formatting.
integer
The unique identifier of the discussion entry to reply to. Provide this to create a nested reply to an existing entry. Omit this to create a top-level entry (new thread) in the discussion.
string
required
The unique identifier of the discussion topic within the course.
string
required
The unique identifier of the Canvas course.
array
A list of file attachment IDs to include, if any.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_DUPLICATE_GROUP_DISCUSSION_TOPICTool to duplicate an existing discussion topic in a Canvas group. Use when you need to create a copy of a group discussion topic with all its settings and content.

Input Parameters

string
required
The unique identifier of the group containing the discussion topic to duplicate.
string
required
The unique identifier of the discussion topic to duplicate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The new name for the assignment.
string
The new due date for the assignment, formatted in ISO 8601 (e.g., ‘2025-10-21T18:48:00Z’).
integer
The new position of this assignment within its assignment group when displayed in lists. Lower numbers appear first.
integer
required
The unique identifier for the course containing the assignment.
boolean
Whether the assignment should be published. Set to True to publish, False to unpublish. If not provided, the existing published status will be retained.
string
The new date when the assignment becomes available to students, formatted in ISO 8601 (e.g., ‘2025-10-21T18:48:00Z’).
string
The new HTML content for the assignment’s description.
string
The new grading type for the assignment. Supported types include ‘pass_fail’, ‘percent’, ‘letter_grade’, ‘gpa_scale’, ‘points’, ‘not_graded’.
integer
required
The unique identifier for the assignment to be edited.
string
The new unique identifier for the assignment from a third-party integration (e.g., an external tool).
integer
The new maximum number of points possible for the assignment.
integer
The new number of submission attempts allowed for the assignment. Use -1 for unlimited attempts.
array
A list of new submission types supported for the assignment. Valid types include ‘online_quiz’, ‘none’, ‘on_paper’, ‘discussion_topic’, ‘external_tool’, ‘online_upload’, ‘online_text_entry’, ‘online_url’.
array
File extensions (e.g., ‘pdf’, ‘docx’) allowed if submission_types includes ‘online_upload’.
integer
The unique identifier of the assignment group to which this assignment should be moved or associated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the conversation to edit.
string ("unread" | "starred" | "archived")
Scope options for generating visible field
array
Used when generating ‘visible’ in the API response. See the explanation under the index API action.
boolean
Toggle the starred state of the current user’s view of the conversation. If true, the conversation is starred; if false, it is unstarred.
boolean
Toggle the current user’s subscription to the conversation (only valid for group conversations). If unsubscribed, the user will still have access to the latest messages, but the conversation won’t be automatically flagged as unread, nor will it jump to the top of the inbox.
string ("and" | "or" | "default or")
Filter mode options for generating visible field
string ("read" | "unread" | "archived")
Workflow state options for a conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_EDIT_QUIZModifies an existing Canvas quiz. Update notifications are requested by default and can be disabled.

Input Parameters

string
New title for the quiz. If None, the title will not be updated.
string
Due date/time for the quiz (ISO 8601 format). No update if None.
string
When students can no longer take the quiz (ISO 8601 format). No update if None.
string
required
Identifier for the quiz to be updated.
string
required
Identifier for the course in which the quiz resides.
string
A comma-separated list of IP addresses or CIDR netmasks (e.g., ‘192.168.1.1/24’) that are allowed to access the quiz. If None, this setting will not be updated.
boolean
If true, the quiz is published and visible to students. If false, it is unpublished. If None, the publication status will not be updated.
string ("practice_quiz" | "assignment" | "graded_survey" | "survey")
The type of the quiz. If None, the type will not be updated.
string
When the quiz becomes available (ISO 8601 format). No update if None.
integer
Time limit for the quiz in minutes. Use null or omit to remove an existing time limit, effectively setting no time limit. If None, the time limit will not be updated.
string
A password to restrict access to the quiz. Setting this to an empty string will remove an existing access code. If None, the access code will not be updated.
string
New HTML description for the quiz. If None, the description will not be updated.
boolean
If true, students cannot go back to previous questions after answering them (only applicable if one_question_at_a_time is true). If None, this setting will not be updated.
string ("always" | "until_after_last_attempt")
Specifies when results should be hidden from students. Use ‘always’ to hide results completely or ‘until_after_last_attempt’ to hide them until the student has completed their final attempt. If None, this setting will not be updated.
string ("keep_highest" | "keep_latest")
Determines which score is kept if multiple attempts are allowed (‘keep_highest’ or ‘keep_latest’). If None, this setting will not be updated.
boolean
If true, answers to quiz questions will be shuffled for each student. If None, this setting will not be updated.
integer
Number of attempts a student is allowed to take for the quiz. Use -1 for unlimited attempts. If None, this setting will not be updated.
boolean
If true, sends notifications to users about the quiz update.
boolean
If true, students can only view their quiz results once (this option is disabled if allowed_attempts > 1). If None, this setting will not be updated.
integer
The ID of the assignment group to associate with the quiz. This is relevant for graded quizzes (e.g., ‘assignment’, ‘graded_survey’). If None, the assignment group will not be updated.
boolean
If true, students can see the correct answers after submitting the quiz (subject to other restrictions like hide_results, show_correct_answers_at, hide_correct_answers_at). If None, this setting will not be updated.
boolean
If true, students will see one question at a time. If None, this setting will not be updated.
string
When correct answers will be hidden (ISO 8601 format). No update if None.
string
When correct answers become visible (ISO 8601 format). No update if None.
boolean
If true, the quiz is only visible to students with specific overridden due dates. If None, this setting will not be updated.
boolean
If true, correct answers will only be shown after the student’s final attempt for quizzes that allow multiple attempts. If None, this setting will not be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_EDIT_USERModifies an existing Canvas user’s profile and settings. Use to update name, email, timezone, bio, pronouns, and other profile fields. To modify login credentials, use the logins API instead.

Input Parameters

string
required
User ID. Can be a Canvas user ID or ‘self’ for the authenticated user.
object
required
User fields to update. At least one field must be provided.
boolean
If false, fields with ‘sticky’ changes will not be updated. Default is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the course whose content is to be exported.
string ("common_cartridge" | "qti" | "zip")
required
Format for the exported content. ‘common_cartridge’ exports the full course in IMS Common Cartridge format, ‘qti’ exports quizzes in QTI format, and ‘zip’ exports files in a zip archive.
boolean
If true, suppresses progress notifications to the initiating user. Defaults to false (notifications are sent).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Optional selective export parameter for group exports. Since groups only support ‘zip’ export type, only ‘folders’ and ‘files’ object types are valid. Keys are object types (‘files’ or ‘folders’). Values are lists of object IDs (can be integers or strings).
string
required
The unique identifier for the group whose content is to be exported.
string ("zip")
required
Format for the exported content. Groups only support ‘zip’ which exports files and folders in a zip archive.
boolean
If true, suppresses progress notifications to the initiating user. Defaults to false (notifications are sent).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Allows exporting specific data. Keys are object types like ‘files’, ‘folders’, ‘pages’, etc. Values are lists of object IDs (integers or strings). Multiple object types can be selected. Common Cartridge supports all object types. Zip and QTI only support specific types: zip supports ‘folders’ and ‘files’, qti supports ‘quizzes’.
string
required
The unique identifier for the user whose content is to be exported. Use ‘self’ to export content for the currently authenticated user.
string ("common_cartridge" | "qti" | "zip")
required
Format for the exported content. ‘common_cartridge’ exports content in IMS Common Cartridge format, ‘qti’ exports quizzes in QTI format, and ‘zip’ exports files in a zip archive.
boolean
If true, suppresses progress notifications to the user. Defaults to false (notifications are sent).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page.
integer
Canvas user ID, required when get_user_courses is true.
integer
Number of items to return per page. Maximum is typically 100. Higher values fetch more data in a single request.
integer
Canvas course ID, required if fetching course-specific data (e.g., assignments, files, users for a course).
boolean
Fetches files for a specific course (requires course_id).
boolean
Fetches pages for a specific course (requires course_id).
boolean
Fetches users for an account. If account_id is not provided, defaults to ‘self’ (current user’s account). Optionally filter users by search_term.
integer
Canvas account ID (numerical ID). If not provided when get_users is true, defaults to the current user’s account. Can be found via get_accounts.
boolean
Fetches courses for the current user, optionally filtered by enrollment_type and enrollment_state.
boolean
Fetches quizzes for a specific course (requires course_id).
string
Search term to filter results when get_users, get_discussion_topics, or get_quizzes is true.
boolean
Fetches Canvas accounts accessible to the current user.
integer
Canvas assignment ID, required when get_submissions is true.
string
Filter for get_courses or get_user_courses by enrollment type.
boolean
Fetches assignments for a specific course (requires course_id).
boolean
Fetches submissions for an assignment within a course (requires course_id and assignment_id).
string
Filter for get_courses or get_user_courses by enrollment state.
boolean
Fetches courses for a specific user (requires user_id), optionally filtered by enrollment_type and enrollment_state.
boolean
When 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).
boolean
Fetches discussion topics for a specific course (requires 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination (1-indexed).
string ("user" | "context")
Type of recipient to search for.
Search terms used for matching users/courses/groups (e.g. “bob smith”). If multiple terms are given (separated via whitespace), only results matching all terms will be returned.
string
Limit the search to a particular course/group (e.g. “course_3” or “group_4”).
array
Array of ids to exclude from the search. These may be user ids or course/group ids prefixed with “course_” or “group_” respectively.
integer
Search for a specific user id. This ignores the other above parameters, and will never return more than one result.
integer
Number of results per page (max 100). Canvas default is typically 10.
array
Array of permission strings to be checked for each matched context (e.g. “send_messages”). This argument determines which permissions may be returned in the response; it won’t prevent contexts from being returned if they don’t grant the permission(s).
integer
When searching by user_id, only users that could be normally messaged by this user will be returned. This parameter allows you to specify a conversation that will be referenced for a shared context — if both the current user and the searched user are in the conversation, the user will be returned. This is used to start new side conversations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Optional additional data to include with the course response. Accepts multiple values to include permissions, observed users, course images, and other course details.
string
required
The unique identifier of the course to retrieve.
string
required
The unique identifier of the Canvas account that owns the course.
integer
Maximum number of teacher enrollments to return when ‘teachers’ is included. If the course has more teachers than this limit, only the teacher count will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_ACCOUNT_GRAPH_QLTool to retrieve account information by ID or SIS ID using the Canvas GraphQL API. Use when you need to fetch account details via GraphQL interface.

Input Parameters

string
GraphQL ID of the account to retrieve. Either id or sisId must be provided.
string
SIS identifier of the account to retrieve. Either id or sisId must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the Canvas account. Use ‘1’ for the root account, or specify a sub-account ID.
boolean
If true, include notifications that have been closed/dismissed by the user. If false or omitted, only active notifications are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_ACCOUNTS_OUTCOME_GROUPSTool to retrieve a specific outcome group from a Canvas account. Use when you need to fetch details about a specific outcome group including its title, description, parent group, and management URLs.

Input Parameters

string
required
The unique identifier of the outcome group to retrieve.
string
required
The unique identifier of the account that owns the outcome group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_ACCOUNTS_THAT_USERS_CAN_CREATE_COURSES_INRetrieves Canvas accounts where the current user has permission to create courses; typically returns results only for administrators.

Input Parameters

integer
The page number to return (1-indexed). Defaults to 1 if not provided.
integer
The number of results to return per page (max 100). Defaults to 10 if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_A_CONTENT_MIGRATION3Tool to retrieve data on an individual content migration from a Canvas group. Use when you need to check the status, progress, or details of a specific group migration.

Input Parameters

string
required
The unique identifier for the content migration.
string
required
The unique identifier for the Canvas group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_A_CONTENT_MIGRATION4Tool to retrieve data on an individual content migration from a Canvas user. Use when you need to check the status, progress, or details of a specific user migration.

Input Parameters

string
required
The unique identifier for the content migration.
string
required
The unique identifier for the Canvas user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_A_LATE_POLICYTool to retrieve the late policy for a Canvas course. Use when you need to check the course’s policy for handling late and missing submissions.

Input Parameters

string
required
The unique identifier of the Canvas course to retrieve the late policy from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination (1-indexed). Use to get results beyond the first page.
integer
Number of outcome alignments to return per page. If omitted, Canvas default is used.
string
required
The unique identifier of the Canvas course.
integer
The id of the student. Returns alignments filtered by student submissions. Can be combined with assignment_id to filter to a specific assignment.
integer
The id of the assignment. When provided without student_id, returns all outcome alignments for the assignment (requires manage_grades or view_all_grades permission). When provided with student_id, filters to that student’s submission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
integer
The number of assignments to return per page.
string
required
REQUIRED - The unique numeric identifier of the Canvas course to retrieve assignments from. This action retrieves assignments for ONE specific course only, not all courses. You MUST obtain a valid course_id first (e.g., from CANVAS_LIST_COURSES) before calling this action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_ALL_E_PORTFOLIOS_FOR_USERLists ePortfolios for a specified Canvas user, paginated. Deleted ePortfolios can be included where permitted.

Input Parameters

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
array
Include deleted ePortfolios. Only available to admins who can moderate_user_content.
string
required
The unique identifier of the user. Can be a numeric user ID or ‘self’ to reference the current authenticated user.
integer
Number of ePortfolios to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of outcome groups to return per page (max 100).
string
required
The unique identifier of the account. Use ‘self’ to refer to the current user’s account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of outcome groups to return per page (max 100).
string
required
The unique identifier of the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
array
Optional list of associations to include with the peer review. Can include ‘submission_comments’ for submission comments or ‘user’ for user objects.
integer
Number of peer reviews to return per page (max 100).
string
required
The unique identifier of the course containing the assignment.
string
required
The unique identifier of the assignment containing the submission.
string
required
The unique identifier of the submission to retrieve peer reviews for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
array
Optional list of associations to include with the peer review. Can include ‘submission_comments’ for submission comments or ‘user’ for user objects.
integer
Number of peer reviews to return per page (max 100).
string
required
The unique identifier of the section.
string
required
The unique identifier of the assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
array
Optional list of associations to include with the peer review. Can include ‘submission_comments’ for submission comments or ‘user’ for user objects.
integer
Number of peer reviews to return per page (max 100).
string
required
The unique identifier of the section containing the assignment.
string
required
The unique identifier of the assignment containing the submission.
string
required
The unique identifier of the submission to retrieve peer reviews for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_ALL_USERSRetrieves a list of users for a specified Canvas account_id (use ‘self’ for the current user’s root account), supporting filtering, sorting, and pagination.

Input Parameters

integer
Page number for pagination (1-indexed).
string
Field to sort users by (e.g., ‘username’, ‘email’, ‘sis_id’, ‘integration_id’, ‘last_login’).
string
Sort direction: ‘asc’ (ascending) or ‘desc’ (descending).
integer
Number of users per page (max 100).
string
required
Unique identifier for the Canvas account; use ‘self’ for the current user’s root account.
string
Filter users by name, username, or email.
array
Filter users by enrollment type (e.g., ‘student’, ‘teacher’, ‘ta’, ‘observer’, ‘designer’).
boolean
If true, include users marked as deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Associations to include with the group. ‘discussion_topic’, ‘assignment_visibility’, and ‘submission’ are only valid if ‘assignments’ is also included. ‘score_statistics’ is only valid if ‘submission’ and ‘assignments’ are also included. The ‘assignment_visibility’ option additionally requires that the Differentiated Assignments course feature be turned on.
string
required
The unique identifier of the course containing the assignment group.
integer
The id of the grading period in which assignment groups are being requested (Requires grading periods to exist on the account).
string
required
The unique identifier of the assignment group to retrieve.
boolean
Apply assignment overrides for each assignment. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_A_PREFERENCEFetches the notification preference for a specific notification on a given communication channel. Use to check how often a user wants to receive a particular type of notification.

Input Parameters

string
required
The ID of the user. Use ‘self’ for the current user or a numeric user ID.
string
required
The name of the notification (e.g., ‘assignment_graded’, ‘course_content_changed’).
string
required
The ID of the communication channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The type of communication channel (e.g., ‘email’, ‘sms’, ‘push’).
string
required
The address of the communication channel. For email type, this is an email address. For SMS, this is a phone number.
string
required
The ID of the user. Use ‘self’ for the current user, a numeric user ID, or a SIS User ID prefixed with ‘sis_user_id:’.
string
required
The name of the notification preference to retrieve (e.g., ‘new_announcement’, ‘assignment_due_date_changed’, ‘access_token_deleted’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_A_SINGLE_EXTERNAL_TOOL2Tool to retrieve detailed information for a specific external tool within a Canvas course. Use when you need to get configuration details, settings, or metadata for an external tool in a course context.

Input Parameters

string
required
The unique identifier of the course containing the external tool.
string
required
The unique identifier of the external tool to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_A_SINGLE_GROUP_MEMBERSHIPTool to retrieve a single group membership by its membership_id or user_id. Use when you need to check membership status, moderator privileges, or workflow state for a specific user in a group.

Input Parameters

string
required
The unique identifier of the group.
string
required
The unique identifier of the group membership or user id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_A_SINGLE_GROUP_MEMBERSHIP2Tool to retrieve a single group membership by user_id. Use when you need to check membership status, moderator privileges, or workflow state for a specific user in a group.

Input Parameters

string
required
The unique identifier of the user. You may use ‘self’ to refer to the current user.
string
required
The unique identifier of the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_ASSIGNMENT2Tool to retrieve information about a specific assignment by ID using the Canvas GraphQL API. Returns assignment details including submissions connection.

Input Parameters

string
required
Assignment identifier (accepts both GraphQL or REST-style IDs).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_ASSIGNMENT_GROUPTool to retrieve information about a specific assignment group by ID. Use when you need to fetch details about an assignment group including its name, position, weight, and state.

Input Parameters

string
required
A GraphQL or legacy Canvas ID for the assignment group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_ASSIGNMENT_RUBRICFetches the detailed rubric for a specified assignment within a Canvas course; returns has_rubric=false if the assignment has no associated rubric.

Input Parameters

string
required
Unique identifier for the course.
string
required
Unique identifier for the assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Returns the last n elements from the list. Used for backward pagination.
string
Returns elements after the specified cursor. Used with ‘first’ for forward pagination.
integer
Returns the first n elements from the list. Used for forward pagination.
string
Returns elements before the specified cursor. Used with ‘last’ for backward pagination.
string
Filter logs until this end time (ISO 8601 datetime format, e.g., ‘2024-12-31T23:59:59Z’).
string
Filter logs from this start time (ISO 8601 datetime format, e.g., ‘2024-01-01T00:00:00Z’).
string
required
The asset string identifier for the object (e.g., ‘account_1’, ‘course_123’). Required to specify which resource’s audit logs to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the user to retrieve graded submissions for. Use ‘self’ for the currently authenticated user, or provide a numeric user ID.
array
Associations to include with the graded submissions. Currently only ‘assignment’ is supported.
boolean
If true, returns submissions for only currently active enrollments. If false or omitted, returns submissions for all enrollments.
boolean
If true, returns submissions for only published assignments. If false or omitted, returns submissions for all assignments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the authentication provider to retrieve.
string
required
The Canvas account ID. Use ‘self’ for the current account or a specific numeric account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_BOOKMARKRetrieves the details for a specific bookmark by ID. Use when you need to fetch information about a particular bookmark for the authenticated user.

Input Parameters

string
required
The unique identifier for the bookmark to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_BRAND_VARIABLESTool to retrieve all brand configuration variables for the Canvas account. Use when you need to access theme colors, logos, watermarks, or other branding customization settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_CONTENT_SHARERetrieves detailed information about a single content share by ID for a specified user. Use when you need to view the details of a specific shared content item.

Input Parameters

string
required
The unique identifier of the content share to retrieve.
string
required
ID of the user whose content share to retrieve. Use ‘self’ for the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_CONTENT_SHARES_UNREAD_COUNTRetrieves the unread content share count for a specified Canvas user, defaulting to the authenticated user.

Input Parameters

string
The unique identifier of the user whose unread content shares count is to be retrieved. Use ‘self’ to retrieve your own unread count. Only linked observers and administrators may view other users’ content shares.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Course identifier. Accepts both GraphQL global identifiers (e.g., ‘Q291cnNlLTE’) and legacy numeric IDs (e.g., ‘1’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_COURSE_ACTIVITY_STREAMTool to retrieve the current user’s course-specific activity stream, paginated. Use when you need to see recent activities in a specific course such as new discussions, announcements, assignments, and submissions.

Input Parameters

integer
Page number to fetch (1-indexed). Use to get results beyond the first page.
integer
Number of items to return per page for pagination. Default is 10.
string
required
The unique identifier of the Canvas course for which to retrieve the activity stream.
boolean
If true, will only return objects for courses the user is actively participating in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
REQUIRED - The unique numeric identifier of the Canvas course to retrieve activity summary from. You MUST obtain a valid course_id first (e.g., from CANVAS_LIST_COURSES) before calling this action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_COURSE_LEVEL_PARTICIPATION_DATARetrieves daily activity analytics, such as page views and participation events, for a specified Canvas course.

Input Parameters

string
required
The unique numerical identifier of the Canvas course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_COURSE_NICKNAMERetrieves the nickname for a specific Canvas course. Use when you need to get the user-defined alternate name for a course.

Input Parameters

string
required
The unique identifier for the Canvas course to retrieve the nickname for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the Canvas course to check permissions for.
array
List of permissions to check against the authenticated user. Permission names are documented in the List assignable permissions endpoint. If not provided, checks all available permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to return (1-indexed). Defaults to 1 if not provided.
integer
The number of results to return per page (max 100). Defaults to 10 if not provided.
string
required
The ID of the course to retrieve assignment overrides from.
array
required
IDs of overrides to retrieve. Must be paired with assignment_overrides_assignment_id - each override ID corresponds to an assignment ID at the same index.
array
required
IDs of assignments for each override. Must be paired with assignment_overrides_id - each assignment ID corresponds to an override ID at the same index.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page.
integer
Number of migrations to return per page (max 100).
string
required
The unique identifier of the associated course for which to retrieve blueprint subscription migrations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_COURSE_SETTINGSTool to retrieve settings for a specific Canvas course. Use when you need to check configuration options like student permissions, grading settings, or display preferences for a course.

Input Parameters

string
required
The unique identifier for the course whose settings are to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the Canvas course. This ID must correspond to an existing course.
string
The full path to the folder relative to the course root folder. If empty or not provided, returns the root folder alone. Do not include the root folder’s name (e.g., ‘course files’). Example: ‘unfiled’ or ‘foo/bar/baz’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_COURSES_FOLDERS_ROOTTool to retrieve the root folder for a course. Use when you need to access the root folder from a course context by using ‘root’ as the folder identifier.

Input Parameters

string
required
The ID of the course to get the root folder for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Optional list of additional fields to include in the response. Common fields: ‘name’, ‘courseCode’, ‘workflowState’, ‘sisId’, ‘createdAt’, ‘updatedAt’, ‘enrollmentTermId’, ‘accountId’, ‘rootAccountId’, ‘timeZone’, ‘startAt’, ‘endAt’, ‘publicSyllabus’, ‘storageQuotaMb’, ‘hideFinalGrades’, ‘applyAssignmentGroupWeights’, ‘defaultView’, ‘uuid’, ‘gradingStandardId’, ‘isPublic’, ‘allowStudentWikiEdits’, ‘allowWikiComments’, ‘allowStudentForumAttachments’, ‘openEnrollment’, ‘selfEnrollment’, ‘restrictEnrollmentsToCourseDates’, ‘template’, ‘homeroom’, ‘blueprint’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_COURSES_OUTCOME_GROUPSRetrieves a specific outcome group for a course. Use when you need to fetch detailed information about an outcome group.

Input Parameters

string
required
The unique identifier for the outcome group.
string
required
The unique identifier for the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_CURRENT_USERRetrieves detailed information about the currently authenticated user from the Canvas LMS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The unique identifier for the user. Use ‘self’ to get the authenticated user’s custom colors, or provide a specific user ID.
string
required
The asset string in the format ‘context_id’ (e.g., ‘course_42’). This identifies the specific context (course, group, etc.) for which to retrieve the custom color.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The ID of the user to retrieve custom colors for. Use ‘self’ for the authenticated user or provide a specific user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_DASHBOARD_POSITIONSTool to retrieve all dashboard positions saved for a user. Use when you need to see the current order of dashboard cards for a specific user.

Input Parameters

string
required
The ID of the user to retrieve dashboard positions for. Use ‘self’ for the current user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique numeric identifier for the Canvas account (which may represent a department or institution) for which to retrieve completed statistics. Must be a valid account ID accessible to the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_DEPARTMENT_LEVEL_CURRENT_STATISTICSFetches a snapshot of current numerical statistics for a Canvas account, requiring its valid ID.

Input Parameters

string
required
The unique identifier for the Canvas account (which may represent a department) for which to retrieve current statistics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the Canvas account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the academic term.
string
required
The unique identifier for the Canvas account (e.g., a specific department).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier for the user whose submission annotations read state is being retrieved.
string
required
Unique identifier for the section.
string
required
Unique identifier for the assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the enrollment object to be retrieved.
string
required
The unique identifier for the account in which the enrollment exists. Often ‘self’ can be used for the current user’s account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_ENROLLMENT_INVITATIONSRetrieves a page of the current user’s enrollments, defaulting to pending invitations. Other enrollment states can be selected.

Input Parameters

integer
Page number to fetch (1-indexed).
array
Filter by enrollment state. Defaults to ‘invited’ to get pending invitations. Can include multiple states like active, inactive, completed, rejected, deleted.
integer
Number of enrollments to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the feature flag to retrieve (e.g., ‘epub_export’, ‘encrypted_sourcedids’, ‘anonymous_instructor_annotations’).
string
required
The unique identifier of the account for which to retrieve the feature flag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the feature flag to retrieve (e.g., ‘analytics_2’, ‘epub_export’, ‘encrypted_sourcedids’). The flag may be defined on the course or inherited from a parent account.
string
required
The unique identifier of the course for which to retrieve the feature flag. The flag may be defined on this course or inherited from a parent account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the file to retrieve.
array
Array of additional information to include. ‘user’ includes the user who uploaded the file or last edited its content.
integer
When a user replaces a file during upload, Canvas keeps track of the ‘replacement chain.’ Include this parameter if you wish Canvas to follow the replacement chain if the requested file was deleted and replaced by another. Indicates the context ID Canvas should use when following the ‘replacement chain.’ The ‘replacement_chain_context_type’ parameter must also be included.
string ("course" | "account")
When a user replaces a file during upload, Canvas keeps track of the ‘replacement chain.’ Include this parameter if you wish Canvas to follow the replacement chain if the requested file was deleted and replaced by another. Must be set to ‘course’ or ‘account’. The ‘replacement_chain_context_id’ parameter must also be included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_FOLDERRetrieves details for a specific folder within a Canvas course. Use ‘root’ as the folder ID to get the root folder for the course context.

Input Parameters

string
required
The folder ID to retrieve. Use ‘root’ to get the root folder for the course.
string
required
The unique identifier for the Canvas course containing the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_FOLDER_BY_IDRetrieves the details for a specific folder by its ID. Use ‘root’ as the ID to get the root folder for a context.

Input Parameters

string
required
The unique identifier of the folder to retrieve. You can use ‘root’ to get the root folder from a context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the Canvas group containing the discussion topic.
string
required
The unique identifier of the discussion topic.
boolean
If true, returns newly created or updated entries not yet reflected in the cached view. These are returned in a separate ‘new_entries’ array in ascending created_at order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_GLOBAL_OUTCOME_GROUPRetrieves a global outcome group by ID from Canvas. Use when you need to get details about a specific global learning outcome group.

Input Parameters

string
required
The unique identifier of the global outcome group to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_GRADEBOOK_HISTORY_DAYSRetrieves a chronological list of dates with grading activity and the active graders for a specified course.

Input Parameters

string
required
The unique identifier for the course for which to retrieve the gradebook history days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Specifies additional details to include in the group response. ‘permissions’: Include permissions the current user has for the group. ‘tabs’: Include the list of tabs configured for each group.
string
required
The unique identifier of the group to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_GROUP_ACTIVITY_STREAMTool to retrieve the current user’s group-specific activity stream, paginated. Use when you need to see recent activities in a specific group such as new discussions, announcements, and other group-related activities.

Input Parameters

integer
Page number to fetch (1-indexed). Use to get results beyond the first page.
string
required
The unique identifier of the Canvas group for which to retrieve the activity stream.
integer
Number of items to return per page for pagination. Default is 10.
boolean
If true, will only return objects for courses the user is actively participating in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_GROUP_ACTIVITY_STREAM_SUMMARYRetrieves a summary of the current user’s group-specific activity stream. Returns counts and unread counts for different activity types within the specified group.

Input Parameters

string
required
The unique identifier for the Canvas group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_GROUP_FOLDERRetrieves the details for a folder within a Canvas group. Use ‘root’ as the folder ID to get the root folder for the group context.

Input Parameters

string
required
The folder ID to retrieve. Use ‘root’ to get the root folder for the group.
string
required
The unique identifier for the Canvas group containing the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the Canvas group to check permissions for.
array
List of permissions to check against the authenticated user. Permission names are documented in the List assignable permissions endpoint. If not provided, checks all available permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_INTERNAL_SETTINGSTool to retrieve all internal settings from Canvas using the GraphQL API. Use when you need to query system-level configuration settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_KALTURA_CONFIGTool to return the config information for the Kaltura plugin in JSON format. Use when you need to check Kaltura integration status or retrieve Kaltura service endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the learning outcome to retrieve. Can be a numeric string or GraphQL global ID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The global GraphQL ID of the learning outcome group to retrieve. This is a base64-encoded string (e.g., ‘TGVhcm5pbmdPdXRjb21lR3JvdXAtNQ==’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Legacy numeric identifier from the REST API. Should be a string representation of the numeric ID.
string ("Account" | "Assignment" | "Course" | "Discussion" | "Enrollment" | "Group" | "Module" | "Page" | "Quiz" | "Section" | "Submission" | "User")
required
The object type to fetch (e.g., Course, Assignment, User).
string
GraphQL fields to retrieve from the object. If not specified, only __typename and _id will be returned. Use GraphQL fragment syntax (e.g., ’… on Course { name enrollmentState }’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_MANUALLY_CREATED_COURSES_ACCOUNTTool to retrieve the manually-created courses sub-account for the domain root account. Use when you need to identify the sub-account that contains courses created manually (as opposed to SIS-imported courses).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_MODULE_ITEMTool to retrieve information about a specific module item by ID using the Canvas GraphQL API. Use when fetching details about a module item including its content, parent module, and metadata.

Input Parameters

string
required
The module item ID (can be GraphQL global ID or legacy numeric ID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_MODULE_ITEM_SEQUENCEFinds the module item sequence for a Canvas course asset using a numeric asset ID. Results may include current, previous and next items and applicable mastery path information.

Input Parameters

integer
The id of the asset (or the url in the case of a Page).
string
required
The unique identifier of the Canvas course.
string ("ModuleItem" | "File" | "Page" | "Discussion" | "Assignment" | "Quiz" | "ExternalTool")
Asset types supported for module item sequence lookup.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_MY_INBOX_SETTINGSTool to retrieve inbox settings for the current user in Canvas. Use when you need to check the authenticated user’s signature settings or out-of-office configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
List of appointment group IDs to search for the next available appointment. If omitted, searches across all appointment groups accessible to the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional GraphQL fragment to specify additional fields to fetch for the node. If not provided, only __typename and id will be returned. Example: ’… on Course { _id name }’
string
required
GraphQL global identifier (Base64 encoded) of the object to fetch. Follows the Relay Object Identification spec. Example: ‘Q291cnNlLTEwOTk=‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the outcome calculation method to retrieve (accepts both GraphQL and REST-style IDs).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_OUTCOME_PROFICIENCY_GRAPH_QLTool to retrieve outcome proficiency information for an account using the Canvas GraphQL API. Use when you need to fetch proficiency ratings and configuration for learning outcomes via GraphQL interface.

Input Parameters

string
required
The ID of the account for which to retrieve outcome proficiency information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed).
array
Specify additional values to exclude. ‘missing_user_rollups’ excludes rollups for users without results. ‘missing_outcome_results’ excludes outcomes without results.
array
Specify additional collections to be side loaded with the result. Available options: courses, outcomes, outcomes.alignments, outcome_groups, outcome_links, outcome_paths, users.
string ("student" | "outcome")
Sort option for outcome result rollups.
integer
Number of outcome rollups to return per page.
array
If specified, only the users whose ids are given will be included in the results or used in an aggregate result. It is an error to specify an id for a user who is not a student in the context.
string ("course")
Aggregate type for outcome rollups.
string
required
The unique identifier for the Canvas course to retrieve outcome rollups from.
string ("asc" | "desc")
Sort order option.
array
If specified, only the outcomes whose ids are given will be included in the results. It is an error to specify an id for an outcome which is not linked to the context.
boolean
If defaults are requested, then color and mastery level defaults will be added to outcome ratings in the rollup. This will only take effect if the Account Level Mastery Scales FF is DISABLED.
string ("mean" | "median")
Aggregate statistic type for rollups.
integer
If outcome sorting requested, then this determines which outcome to use for rollup score sorting.
boolean
DEPRECATED: This parameter is deprecated. Use the separate GET /api/v1/courses/:course_id/outcomes/:outcome_id/contributing_scores endpoint instead to fetch contributing scores for a specific outcome. If contributing scores are requested, then each individual outcome score will also include all graded artifacts that contributed to the outcome score.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Specify additional collections to be side loaded with the result. Allowed values: ‘alignments’ (includes only the alignments referenced by the returned results), ‘outcomes’ (includes outcome details), ‘outcomes.alignments’ (includes all alignments referenced by outcomes in the context), ‘outcome_groups’ (includes outcome groups), ‘outcome_links’ (includes outcome links), ‘outcome_paths’ (includes outcome paths), ‘users’ (includes user details).
array
If specified, only the users whose ids are given will be included in the results. SIS ids can be used, prefixed by ‘sis_user_id:’. It is an error to specify an id for a user who is not a student in the context.
string
required
The ID of the course to retrieve outcome results for.
array
If specified, only the outcomes whose ids are given will be included in the results. It is an error to specify an id for an outcome which is not linked to the context.
boolean
If true, results that are hidden from the learning mastery gradebook and student rollup scores will be included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the Canvas course.
string
required
The URL (e.g., ‘my-first-page’) or the numeric ID of the page. If a page URL might be identical to another page’s numeric ID, prefix the ID with ‘page_id:’ (e.g., ‘page_id:5678’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The identifier of the course for which to retrieve proficiency ratings. If not defined for this course, it will return proficiency ratings for the account or nearest super-account with ratings defined.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the file for which to retrieve the public inline preview URL.
integer
The id of the submission the file is associated with. Provide this argument to gain access to a file that has been submitted to an assignment (Canvas will verify that the file belongs to the submission and the calling user has rights to view the submission).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_QUIZ_REPORTRetrieves data for a single quiz report, including available status and report file information for a previously generated report.

Input Parameters

string
required
The ID of the specific quiz report to retrieve.
string ("file" | "progress")
Whether the output should include documents for the file and/or progress objects associated with this report. (Note: JSON-API only)
string
required
The ID of the quiz for which to retrieve the report.
string
required
The ID of the course containing the quiz.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the quiz to fetch statistics for.
string
required
The unique identifier of the course containing the quiz.
boolean
Whether the statistics report should include all submission attempts. If false or omitted, only the latest submission attempts are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_QUIZ_SUBMISSIONSRetrieves a page of submissions for a specific quiz within a course, with a next-page token when available.

Input Parameters

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
array
Optional. Specifies related resources like ‘submission’, ‘quiz’, or ‘user’ to include with each submission. If omitted or empty, minimal data is returned.
string
required
The unique ID of the quiz.
integer
Number of quiz submissions to return per page (max 100).
string
required
The unique ID of the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Unique identifier for the user. Use ‘self’ to get the authenticated user’s quota information, or provide a specific user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_QUOTA_INFORMATION_GROUPSReturns the total and used storage quota for the group. Use this to check available storage space and monitor usage for a specific group.

Input Parameters

string
required
The unique Canvas identifier for the group whose quota information is to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_REPORT_STATUSRetrieves the status of a previously initiated report in a Canvas account, specified by its type and ID.

Input Parameters

string
required
Unique identifier of the specific report instance, usually obtained when report generation is initiated.
string
required
Type or name of the report, typically a predefined report type within Canvas.
string
required
Unique identifier for the Canvas account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_ROOT_OUTCOME_GROUP_FOR_COURSERetrieves the root outcome group for a specified course context. Use when you need to access the top-level outcome group hierarchy for a course.

Input Parameters

string
required
The unique identifier of the course for which to retrieve the root outcome group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Canvas rubric ID to retrieve. Can be either a GraphQL global identifier (for use with node query) or a legacy numeric ID (for use with legacyNode query).
boolean
If true, uses legacyNode query with numeric _id (default); if false, uses node query with GraphQL global identifier. Most Canvas integrations use numeric IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier for the user (student) whose submission read state is being checked.
string
required
Unique identifier for the section.
string
required
Unique identifier for the assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_RUBRICS_UPLOAD_TEMPLATETool to retrieve a CSV template file for importing rubrics into Canvas. Use when you need the template format for bulk rubric imports.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_RUNNING_BATCHESTool to retrieve any currently running conversation batches for the current user. Use when checking the status of bulk private messages that were sent asynchronously.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the section to retrieve.
array
Additional data to include in the response. Options: ‘students’ (requires permission to view users/grades), ‘avatar_url’ (avatar URLs for students), ‘enrollments’ (section enrollment for each student, requires ‘students’), ‘total_students’ (total active and invited students), ‘passback_status’ (grade passback status), ‘permissions’ (whether section grants manage_calendar permission).
string
required
The unique identifier for the Canvas course containing the section.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the section to retrieve.
array
Additional data to include in the response. Options: ‘students’ (requires permission to view users/grades), ‘avatar_url’ (avatar URLs for students), ‘enrollments’ (section enrollment for each student, requires ‘students’), ‘total_students’ (total active and invited students), ‘passback_status’ (grade passback status), ‘permissions’ (whether section grants manage_calendar permission).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
If true, the response will take into account student groups. Defaults to false if not provided.
string
required
The unique identifier of the Canvas section.
string
required
The unique identifier of the assignment.
boolean
If true, the response will include deactivated students in the summary. Defaults to false if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The external id of the tool to launch. Required unless resource_link_lookup_uuid or url is provided, or launch_type is assessment or module_item.
string
The LTI launch url for the external tool. Required unless resource_link_lookup_uuid or id is provided, or launch_type is assessment or module_item.
string
required
The Canvas account ID to get the sessionless launch URL for. This is a required path parameter.
string ("assessment" | "module_item")
Supported launch types for external tools.
string
The assignment id for an assignment launch. Required if launch_type is set to “assessment”.
string
The module item id for a module item launch. Required if launch_type is set to “module_item”.
The identifier to lookup a resource link. This is preferred over id, url, and launch_type parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The external id of the tool to launch. Required unless resource_link_lookup_uuid or url is provided, or launch_type is assessment or module_item.
string
The LTI launch url for the external tool. Required unless resource_link_lookup_uuid or id is provided, or launch_type is assessment or module_item.
string
required
The Canvas course ID to get the sessionless launch URL for. This is a required path parameter.
string ("assessment" | "module_item")
Supported launch types for external tools.
string
The assignment id for an assignment launch. Required if launch_type is set to “assessment”.
string
The module item id for a module item launch. Required if launch_type is set to “module_item”.
The identifier to lookup a resource link. This is preferred over id, url, and launch_type parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the account. Can be either a numeric account ID or a SIS ID in the format ‘sis_account_id:value’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_SINGLE_ASSIGNMENT_OVERRIDERetrieves details of the assignment override with the given id for a specific assignment in a course.

Input Parameters

string
required
Unique identifier for the assignment override to retrieve.
string
required
Unique identifier for the course containing the assignment.
string
required
Unique identifier for the assignment containing the override.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_SINGLE_CALENDAR_EVENTTool to retrieve a single calendar event or assignment by ID from Canvas. Use when you need detailed information about a specific calendar item.

Input Parameters

string
required
The unique identifier for the calendar event or assignment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the conversation to retrieve.
string ("unread" | "starred" | "archived")
Scope values for filtering conversation visibility.
array
Used when generating ‘visible’ in the API response. Narrows results by course/group context.
string ("and" | "or" | "default or")
Filter mode for combining filter criteria.
boolean
Default true. If true, unread conversations will be automatically marked as read. This will default to false in a future API release, so clients should explicitly send true if that is the desired behavior.
boolean
(Obsolete) Submissions are no longer linked to conversations. This parameter is ignored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Specifies optional additional data to include with the course response. Allowed values: ‘needs_grading_count’, ‘syllabus_body’, ‘public_description’, ‘total_scores’, ‘current_grading_period_scores’, ‘term’, ‘account’, ‘course_progress’, ‘sections’, ‘storage_quota_used_mb’, ‘total_students’, ‘passback_status’, ‘favorites’, ‘teachers’, ‘observed_users’, ‘all_courses’, ‘permissions’, ‘course_image’, ‘banner_image’, ‘concluded’, ‘lti_context_id’, ‘post_manually’.
integer
required
The unique identifier for the Canvas course to retrieve.
integer
If ‘teachers’ is in include, limits the number of teacher enrollments returned; API default applies otherwise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_SINGLE_EXTERNAL_TOOLTool to retrieve detailed information for a specific external tool within a Canvas account. Use when you need to get configuration details, settings, or metadata for an external tool.

Input Parameters

string
required
The unique identifier of the account containing the external tool.
string
required
The unique identifier of the external tool to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_SINGLE_GRADING_STANDARD_IN2Retrieves a single grading standard for the given course context that is visible to the user. Use when you need to view the complete configuration and grading scheme of a specific grading standard within a course.

Input Parameters

string
required
The unique identifier of the course that contains the grading standard.
string
required
The unique identifier of the grading standard to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_SINGLE_POLLTool to retrieve a single poll by its ID from Canvas. Use when you need to fetch detailed information about a specific poll including its question, description, creation time, and aggregated results.

Input Parameters

string
required
The unique identifier of the poll to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_SINGLE_POLL_CHOICETool to retrieve a single poll choice by its ID from a Canvas poll. Use when you need to fetch detailed information about a specific poll choice option including its text, position, and correctness status.

Input Parameters

string
required
The unique identifier of the poll choice to retrieve.
string
required
The unique identifier of the poll containing the poll choice to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_SINGLE_QUIZRetrieves detailed information for a specific quiz in a Canvas course. Use when you need to view quiz settings, questions count, due dates, or other quiz metadata.

Input Parameters

string
required
The unique identifier of the quiz to retrieve.
string
required
The unique identifier of the course containing the quiz.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique ID of the quiz submission.
array
Associations to include with the quiz submission. Options: ‘submission’ (assignment submission data), ‘quiz’ (quiz details), ‘user’ (student info).
string
required
The unique ID of the quiz.
string
required
The unique ID of the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_SINGLE_SUBMISSIONRetrieves a specific submission for an assignment made by a particular user within a designated course.

Input Parameters

array
Additional related resources to include with the submission. Allowed values: ‘submission_history’, ‘submission_comments’, ‘submission_html_comments’, ‘rubric_assessment’, ‘full_rubric_assessment’, ‘visibility’, ‘course’, ‘user’, ‘read_status’, ‘student_entered_score’.
string
required
ID of the user whose submission is being retrieved, or ‘self’ for the current authenticated user.
string
required
ID of the course.
string
required
ID of the assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Additional related resources to include with the submission. Allowed values: ‘submission_history’, ‘submission_comments’, ‘submission_html_comments’, ‘rubric_assessment’, ‘full_rubric_assessment’, ‘visibility’, ‘course’, ‘user’, ‘read_status’, ‘student_entered_score’.
string
required
ID of the user whose submission is being retrieved.
string
required
ID of the section.
string
required
ID of the assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Specifies additional data to include in the response. Options: ‘all_dates’ (includes all dates associated with graded discussions’ assignments), ‘sections’ (includes course sections associated with the topic if section-specific), ‘sections_user_count’ (includes user count per section or total users in topic context), ‘overrides’ (includes assignment overrides if applicable).
string
required
The unique identifier of the discussion topic to retrieve.
string
required
The unique identifier of the course containing the discussion topic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Specifies additional data to include in the response. Options: ‘all_dates’ (includes all dates associated with graded discussions’ assignments), ‘sections’ (includes course sections associated with the topic if section-specific), ‘sections_user_count’ (includes user count per section or total users in topic context), ‘overrides’ (includes assignment overrides if applicable).
string
required
The unique identifier of the group containing the discussion topic.
string
required
The unique identifier of the discussion topic to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the user to retrieve.
array
Specifies additional details to include in the user response (e.g., ‘enrollments’, ‘avatar_url’, ‘bio’).
string
required
The unique identifier for the Canvas course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the Canvas course to retrieve the report status from.
string
required
The type of report to query. Common report types include ‘student_analysis’ and ‘item_analysis’. The report type must match one of the available report names configured for the Canvas instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_SUB_ACCOUNTSLists sub-accounts of a Canvas account, with optional recursive retrieval. Results are returned one page at a time.

Input Parameters

integer
The page number to return (1-indexed). Defaults to 1 if not provided.
string ("id" | "name")
Sorts the accounts by id or name. Only applies when recursive is false. Defaults to id.
array
Array of additional information to include. ‘course_count’ returns the number of courses directly under each account. ‘sub_account_count’ returns the number of sub-accounts directly under each account.
integer
The number of results to return per page (max 100). Defaults to 10 if not provided.
boolean
If true, the entire account tree underneath this account will be returned (though still paginated). If false, only direct sub-accounts of this account will be returned. Defaults to false.
string
required
The unique identifier of the Canvas account for which to retrieve sub-accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the submission to retrieve. Accepts both GraphQL global identifiers and legacy numeric IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
If true, the response will take into account student groups. Defaults to false if not provided.
string
required
The unique identifier of the Canvas course.
string
required
The unique identifier of the assignment.
boolean
If true, the response will include deactivated students in the summary. Defaults to false if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_TERMS_OF_SERVICETool to retrieve the terms of service for a Canvas account. Use when you need to access the terms of service content, acceptance requirements, or registration settings for an account.

Input Parameters

string
required
The unique identifier of the account. Use ‘self’ for the current user’s account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Associations to include with the quiz submission. Allowed values: ‘submission’, ‘quiz’, ‘user’. If omitted, minimal data is returned.
string
required
The unique ID of the quiz.
string
required
The unique ID of the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_UNREAD_COUNTTool to get the number of unread conversations for the current user. Use when you need to check how many unread conversations the authenticated user has.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_UPLOADED_MEDIA_FOLDER_FOR_USERTool to retrieve the details for a designated upload folder that the user has rights to upload media to, creating it if it doesn’t exist. Use when you need to access or manage the media upload folder for a specific course.

Input Parameters

string
required
The unique identifier of the course for which to retrieve the uploaded media folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the group for which to retrieve the uploaded media folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
If true, will only return objects for courses the user is actively participating in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_USER_ASSIGNMENT_ANALYTICSFetches detailed assignment-level analytics for a specific student in a designated course, including submission details and class performance statistics.

Input Parameters

integer
required
The unique identifier for the course.
integer
required
The unique identifier for the student.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_USER_AVATARSRetrieves a page of available avatar options for a Canvas user, including uploaded images and default options.

Input Parameters

integer
The page number to return (1-indexed). Defaults to 1 if not provided.
string
Unique identifier for the user. Use ‘self’ to get the authenticated user’s avatar options, or provide a specific user ID.
integer
The number of results to return per page (max 100). Defaults to 10 if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the content export to retrieve.
string
required
The unique identifier for the user. Can be a numeric ID or ‘self’ for the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the user whose course progress is being requested. Use ‘self’ to fetch progress for the currently authenticated user.
string
required
The unique numerical identifier of the course for which progress is being requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the file to retrieve.
array
Array of additional information to include. ‘user’ includes the user who uploaded the file or last edited its content.
string
required
The unique identifier of the user. Can be ‘self’ for the current user or a specific user ID.
integer
When a user replaces a file during upload, Canvas keeps track of the ‘replacement chain.’ Include this parameter if you wish Canvas to follow the replacement chain if the requested file was deleted and replaced by another. Indicates the context ID Canvas should use when following the ‘replacement chain.’ The ‘replacement_chain_context_type’ parameter must also be included.
string ("course" | "account")
When a user replaces a file during upload, Canvas keeps track of the ‘replacement chain.’ Include this parameter if you wish Canvas to follow the replacement chain if the requested file was deleted and replaced by another. Must be set to ‘course’ or ‘account’. The ‘replacement_chain_context_id’ parameter must also be included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the folder to retrieve. Use ‘root’ to get the root folder for the user context.
string
required
The unique identifier of the user whose folder to retrieve. Use ‘self’ to refer to the current authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the migration issue to retrieve.
string
required
The unique identifier for the user. Use ‘self’ to refer to the current authenticated user.
string
required
The unique identifier for the content migration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_USER_PARTICIPATION_ANALYTICSRetrieves page-view activity and participation details for a student in a Canvas course. The analytics include hourly page-view counts and participation events.

Input Parameters

string
required
The unique identifier of the course for which to retrieve analytics.
string
required
The unique identifier of the student for whom to retrieve analytics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_USER_PROFILERetrieves profile information for an existing Canvas user.

Input Parameters

string
Unique identifier for the user. Use ‘self’ to get the authenticated user’s profile, or provide a specific user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Namespace parameter (required) to prevent custom_data collisions between different applications. Should use reverse DNS format like ‘com.organization.app’.
string
Optional scope path that defines the structure of JSON data to retrieve. When provided, retrieves data from /custom_data/{scope}. Leave empty to retrieve all custom data.
string
The user ID. Use ‘self’ for the authenticated user, or provide a specific user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Restricts returned information. ‘names’ returns file name information only (minimal response).
integer
The page number to return (1-indexed). Defaults to 1 if not provided.
string ("name" | "size" | "created_at" | "updated_at" | "content_type" | "user")
Sort results by this field. Defaults to ‘name’.
string ("asc" | "desc")
The sorting order. Defaults to ‘asc’.
array
Array of additional information to include: ‘user’ includes the user who uploaded the file, ‘usage_rights’ includes copyright and license information.
integer
The number of results to return per page (max 100). Defaults to 10 if not provided.
string
The partial name of the files to match and return. Searches file display names.
array
Filter results by content-type. You can specify type/subtype pairs (e.g., ‘image/jpeg’), or simply types (e.g., ‘image’).
array
Exclude specified content-types from results. Same format as content_types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Unique identifier for the user. Use ‘self’ to get the authenticated user’s token, or provide a specific user ID.
string
required
The ID of the token to retrieve, or the token_hint value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_VISIBLE_COURSE_NAVIGATION_TOOLSTool to get external tools with course_navigation placement that are visible to the requesting user. Use when you need to see which external tools appear in the course navigation menu for one or more courses.

Input Parameters

array
required
List of context_codes to retrieve visible course nav tools for (for example, course_123). Only courses are presently supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_GET_VISIBLE_COURSE_NAVIGATION_TOOLS_FORRetrieves external tools with course_navigation placement that are visible in the course navigation for a specific course. Use when you need to see which external tools appear in the course navigation menu for a given course.

Input Parameters

string
required
The unique identifier of the Canvas course to retrieve visible navigation tools for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
If true, marks submission ‘excused’. Excused assignments typically don’t affect total grade.
integer
Specific attempt number for the comment, if multiple attempts allowed.
string
The name of a sticker to apply to the submission (e.g., ‘apple’, ‘star’).
integer
required
The unique identifier for the user (student) whose submission is being addressed.
integer
required
The unique identifier for the course.
string
Grade/score to assign (e.g., ‘95’, ‘A-’). Updates ‘score’ and ‘grade’ in Canvas. Overwrites any existing instructor-entered score.
string
A textual comment to add to the submission.
integer
required
The unique identifier for the assignment within the course.
boolean
If true, comment is visible to student’s group (if a group assignment).
string
Identifier for a pre-existing media comment. Obtaining this ID may require UI interaction due to Canvas API limitations for its management.
string
Sets late policy status. If omitted, existing status is unchanged.
string
Type of media comment (e.g., ‘audio’, ‘video’), relevant if media_comment_id is provided.
integer
Overrides calculated lateness in seconds; used with late_policy_status or for manual adjustment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Set to true to excuse the assignment for this student. Excused assignments do not affect the student’s grade.
array
Additional associations to include in the response. submission_comments is always included by default.
string ("apple" | "basketball" | "bell" | "book" | "bookbag" | "briefcase" | "bus" | "calendar" | "chem" | "design" | "pencil" | "beaker" | "paintbrush" | "computer" | "column" | "pen" | "tablet" | "telescope" | "calculator" | "paperclip" | "composite_notebook" | "scissors" | "ruler" | "clock" | "globe" | "grad" | "gym" | "mail" | "microscope" | "mouse" | "music" | "notebook" | "page" | "panda1" | "panda2" | "panda3" | "panda4" | "panda5" | "panda6" | "panda7" | "panda8" | "panda9" | "presentation" | "science" | "science2" | "star" | "tag" | "tape" | "target" | "trophy")
Assign a sticker to the submission for visual feedback.
string
required
The ID of the student (user) whose submission to grade or comment on.
string
required
The ID of the section containing the assignment.
boolean
Set to true to update the peer review sub-assignment submission instead of the parent assignment. Requires peer reviews enabled and peer_review_allocation_and_grading feature flag.
string
Grade to assign. Can be a number (e.g., ‘85’), percentage (e.g., ‘85%’), letter grade (e.g., ‘A-’), or pass/fail/complete/incomplete. Updates both score and grade fields.
string
Add a text comment to the submission.
string
required
The ID of the assignment to grade or comment on.
integer
The attempt number (starts at 1) to associate the comment with.
array
List of file IDs to attach to the comment. Files must be previously uploaded using the Submission Comment API’s files action.
string
Rubric assessment data. Format: For each criterion, provide points, rating_id, and/or comments as query-string formatted data (e.g., ‘rubric_assessment[crit1][points]=3&rubric_assessment[crit1][rating_id]=rat1&rubric_assessment[crit1][comments]=Well Done’). Requires permission to manage grades.
string
Set the late policy status. Valid values: ‘late’, ‘missing’, ‘extended’, ‘none’, or null. Note: ‘extended’ may require specific UI features enabled.
boolean
Set to true to send the comment to the entire group for group assignments. Requires text_comment to be provided. Defaults to false.
integer
Override the number of seconds late. Only valid when late_policy_status is ‘late’.
string
ID of an audio/video media comment to attach. Note: API for generating/listing media comments is limited.
boolean
If true, treat posted_grade as raw points even if the value matches a grading scheme value.
string ("audio" | "video")
Type of media comment being added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_HIDE_ALL_STREAM_ITEMSTool to hide all activity stream items for the current user. Use when the user wants to clear their entire activity stream.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of section IDs for which to hide assignment grades. Must contain at least one section ID.
string
required
The unique identifier of the assignment whose grades should be hidden.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_HIDE_STREAM_ITEMTool to hide a stream item from the user’s activity stream. Use when you want to remove a specific activity item from view.

Input Parameters

string
required
The unique identifier of the activity stream item to hide.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the destination outcome group into which the source group will be imported.
boolean
If true, perform action asynchronously and return a Progress object instead of an OutcomeGroup. Use the progress endpoint to query the status. The imported outcome group id and url will be returned in the Progress results as ‘outcome_group_id’ and ‘outcome_group_url’.
string
required
The unique identifier for the Canvas course where the destination outcome group resides.
string
required
The ID of the source outcome group to import. The system will create a new subgroup with the same title and description, link the same outcomes, and recursively import any subgroups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the group to which the invitations will be sent.
array
required
An array of email addresses to be sent invitations. Each email will receive an invitation allowing them to join the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the group to leave.
string
required
The unique identifier of the group membership to remove. Use ‘self’ to leave your own membership.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the user leaving the group. You may use ‘self’ to refer to the current user.
string
required
The unique identifier of the group to leave.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of notifications to return per page (max 100).
string
required
The unique identifier of the Canvas account to retrieve notifications for. Can be a numeric ID or ‘self’ for the current user’s account.
boolean
Include all global announcements, regardless of user’s role or availability date. Only available to account admins.
boolean
Include past and dismissed global announcements. If false or omitted, only active notifications not closed by the user are returned.
boolean
Include a flag for each notification indicating whether it has been read/closed by the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of accounts to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
integer
Number of items to return per page for pagination. Canvas default is typically 10-20 items.
boolean
If true, will only return objects for courses the user is actively participating in. If false or omitted, returns activity from all courses including concluded ones.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_ALL_COURSES_GRAPH_QLTool to retrieve all courses that the user is enrolled in using the Canvas GraphQL API. Returns information about courses on the user’s dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page token or number to fetch. Use the next_page value from a previous response to get the next page of results.
integer
Number of folders to return per page. Default is 10.
string
required
The unique identifier of the Canvas course for which to list folders. This ID must correspond to an existing course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
required
The unique identifier of the Canvas group for which to list folders. This ID must correspond to an existing group.
integer
Number of folders to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
required
The unique identifier of the Canvas user for which to list folders. Use ‘self’ to refer to the currently authenticated user.
integer
Number of folders to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
array
Optional list of resources to include with the response. Possible values: ‘sections’, ‘sections_user_count’. If ‘sections’ is passed, includes the course sections associated with the topic if specific to certain sections. If ‘sections_user_count’ is passed and sections were requested and topic is section-specific, includes the number of users in each section; otherwise, includes the total number of users in the topic’s context.
string
Only return announcements posted before the end_date (inclusive). Defaults to 28 days from start_date. The value should be formatted as yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ. Announcements scheduled for future posting will only be returned to course administrators.
integer
Number of announcements to return per page (max 100).
string
Only return announcements posted since the start_date (inclusive). Defaults to 14 days ago. The value should be formatted as yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ.
boolean
Only return active announcements that have been published. Applies only to requesting users that have permission to view unpublished items. Defaults to false for users with access to view unpublished items, otherwise true and unmodifiable.
boolean
Only return the latest announcement for each associated context. The response will include at most one announcement for each specified context in the context_codes parameter. Defaults to false.
array
required
List of context codes to retrieve announcements for (e.g., ‘course_123’, ‘course_456’). Only courses are presently supported. The call will fail unless the caller has View Announcements permission in all listed courses.
string
Only return announcements having locked_at nil or after available_after (exclusive). The value should be formatted as yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ. Effective only for students (who don’t have moderate forum right).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
Determines the scope of appointment groups to retrieve. For example, ‘reservable’ returns groups the user can sign up for.
array
List of additional data to include with each appointment group. Possible values: ‘appointments’, ‘child_events’, ‘participant_count’, ‘reserved_times’, ‘all_context_codes’.
integer
Number of appointment groups to return per page (max 100).
array
List of context codes (e.g., ‘course_123’ or ‘group_456’) to filter appointment groups by specific courses or groups. If omitted, groups from all relevant contexts are returned.
boolean
If true, appointment groups that have already passed will be included in the results. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
array
Associations to include with the group. ‘discussion_topic’, ‘all_dates’, ‘can_edit’, ‘assignment_visibility’, and ‘submission’ are only valid if ‘assignments’ is also included. ‘score_statistics’ requires that ‘assignments’ and ‘submission’ options are included. The ‘assignment_visibility’ option additionally requires that the Differentiated Assignments course feature be turned on. If ‘observed_users’ is passed along with ‘assignments’ and ‘submission’, submissions for observed users will also be included as an array. The ‘peer_review’ option requires that the Peer Review Grading course feature be turned on and that ‘assignments’ is included.
integer
The number of assignment groups to return per page. If not specified, Canvas API default will be used.
string
required
The unique identifier of the Canvas course to retrieve assignment groups from.
array
If ‘assignments’ are included, optionally return only assignments having their ID in this array.
integer
The id of the grading period in which assignment groups are being requested. Requires grading periods to exist.
boolean
Apply assignment overrides for each assignment. Defaults to true if not specified.
boolean
If true, all assignments returned will apply to the current user in the specified grading period. If assignments apply to other students in the specified grading period, but not the current user, they will not be returned. Requires the grading_period_id argument and grading periods to exist. In addition, the current user must be a student.
array
If ‘assignments’ are included, those with the specified submission types will be excluded from the assignment groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
integer
The number of assignment overrides to return per page.
string
required
The unique identifier of the Canvas course containing the assignment.
string
required
The unique identifier of the assignment to retrieve overrides for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
string ("past" | "overdue" | "undated" | "ungraded" | "unsubmitted" | "upcoming" | "future")
Filter assignments by due date and submission status.
array
Optional information to include with each assignment: ‘submission’ (current user’s submission), ‘assignment_visibility’ (array of student IDs who can see it), ‘all_dates’ (array of AssignmentDate structures including overrides), ‘overrides’ (array of AssignmentOverride structures), ‘observed_users’ (submissions for observed users), ‘can_edit’ (whether caller can edit), ‘score_statistics’ (min/max/mean scores, requires 5+ graded assignments), ‘ab_guid’ (academic benchmark GUIDs).
string ("position" | "name" | "due_at")
Determines the order of the assignments.
integer
The number of assignments to return per page.
string
required
The unique identifier of the Canvas course.
boolean
Return only New Quizzes assignments.
boolean
Return only assignments that have post_to_sis set or not set.
string
The partial title of the assignments to match and return.
array
If set, return only assignments specified by these IDs.
string
required
The unique identifier of the assignment group.
boolean
Apply assignment overrides for each assignment, defaults to true.
boolean
Split up ‘needs_grading_count’ by sections into the ‘needs_grading_count_by_section’ key, defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
string
Filter assignments by due date and submission status. Allowed values: ‘past’ (submitted and graded), ‘overdue’ (past due and not submitted), ‘undated’ (no due date), ‘ungraded’ (submitted but not graded), ‘unsubmitted’ (not yet submitted), ‘upcoming’ (due soon), ‘future’ (due in future).
array
Optional information to include with each assignment. Allowed values: ‘submission’ (current user’s submission), ‘assignment_visibility’ (user IDs who can see), ‘all_dates’ (all dates including overrides), ‘overrides’ (assignment overrides), ‘observed_users’ (observed users’ submissions), ‘can_edit’ (if user can edit), ‘score_statistics’ (score stats), ‘ab_guid’ (A/B test info).
string
required
The unique identifier of the user to retrieve assignments for. Use ‘self’ to refer to the current authenticated user.
string
Determines the order of the assignments. Allowed values: ‘position’ (course order), ‘name’ (alphabetical), ‘due_at’ (by due date). Defaults to ‘position’.
integer
The number of assignments to return per page. Canvas default is typically 10.
string
required
The unique identifier of the course to retrieve assignments from.
boolean
Return only New Quizzes assignments. Set to true to filter for New Quizzes only.
boolean
Return only assignments that have post_to_sis set (true) or not set (false). If omitted, returns all assignments regardless of this setting.
string
Filter assignments by partial title match. Returns only assignments whose title contains this search term.
array
If set, return only assignments with the specified IDs. Useful for retrieving specific assignments.
boolean
Apply assignment overrides for each assignment. Defaults to true in the API if not specified.
boolean
Split up needs_grading_count by sections into the needs_grading_count_by_section key. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination (1-indexed). Use to get results beyond the first page.
boolean
If set to true, and the assignment is a group assignment, the submissions will be grouped by student group. Otherwise, submissions are returned ungrouped. Defaults to false if not provided.
array
A list of optional related resources to include in the response for each submission. Common values include ‘submission_history’, ‘submission_comments’, ‘user’, and ‘assignment’.
integer
Number of submissions to return per page (max 100). If omitted, Canvas default (10) is used. Set to a higher value (e.g., 100) to get more submissions.
string
required
The unique identifier of the course.
string
required
The unique identifier of the assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_ASSIGNMENT_SUBMISSIONS_BY_SECTIONLists a page of submissions for an assignment within a specific section, with pagination for subsequent pages.

Input Parameters

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
boolean
If set to true, and the assignment is a group assignment, the submissions will be grouped by student group. Otherwise, submissions are returned ungrouped. Defaults to false if not provided.
array
A list of optional related resources to include in the response for each submission. Common values include ‘submission_history’, ‘submission_comments’, ‘user’, and ‘assignment’.
integer
Number of submissions to return per page (max 100).
string
required
The unique identifier of the section.
string
required
The unique identifier of the assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
required
The unique identifier for the user. Use ‘self’ for the authenticated user or provide a specific user ID.
string
The end of the time range from which you want events. ISO 8601 format (e.g., ‘2023-12-31T23:59:59Z’).
integer
Number of events to return per page (max 100).
string
The beginning of the time range from which you want events. Events are stored for one year. ISO 8601 format (e.g., ‘2023-01-01T00:00:00Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of account calendars to return per page (max 100).
string
When included, searches available account calendars for the term. Returns matching results. Term must be at least 2 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_AVAILABLE_REPORTSLists available reports (including those that can be or have been generated) for a valid Canvas account ID.

Input Parameters

integer
The page number to return (1-indexed). Defaults to 1 if not provided.
integer
The number of results to return per page (max 100). Defaults to 10 if not provided.
string
required
The unique identifier for the Canvas account for which to list available reports. This ID can typically be found in the Canvas URL or account settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Optional flag to return the tabs associated with a canvas_for_elementary subject course’s home page instead of the typical sidebar navigation. Only takes effect if this request is for a course context in a canvas_for_elementary-enabled account or sub-account.
string
required
The unique identifier of the course for which to retrieve available tabs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Optional flag to return the tabs associated with a canvas_for_elementary subject course’s home page instead of the typical sidebar navigation. Only takes effect if this request is for a course context in a canvas_for_elementary-enabled account or sub-account.
string
required
The unique identifier of the group for which to retrieve available tabs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Optional flag to return the tabs associated with a canvas_for_elementary subject course’s home page instead of the typical sidebar navigation. Only takes effect if this request is for a course context in a canvas_for_elementary-enabled account or sub-account.
string
required
The unique identifier of the user. Use ‘self’ for the current authenticated user or provide a specific user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_BLACKOUT_DATESRetrieves blackout dates for a Canvas account context. An empty result can also indicate a 403 or 404 response, rather than no configured dates.

Input Parameters

string
required
The unique identifier for the Canvas account whose blackout dates are to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_BLUEPRINT_IMPORTSLists blueprint migrations imported into an associated course, with pagination. A 404 response is returned as an empty list.

Input Parameters

integer
Page number to fetch (1-indexed). Use to get results beyond the first page.
integer
Number of migrations to return per page (max 100).
string
required
The unique identifier of the course associated with a blueprint subscription.
string
The ID of the blueprint subscription. Use ‘default’ to use the currently active blueprint subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of bookmarks to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string ("event" | "assignment" | "sub_assignment")
Type of calendar item to filter by. Defaults to ‘event’. Use ‘event’ for general calendar events, ‘assignment’ for assignments, or ‘sub_assignment’ for sub-assignments.
boolean
Defaults to false (dated events only). If true, only return undated events and ignore start_date and end_date.
string
Only return events before the end_date (inclusive). Defaults to start_date. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ. If end_date is the same as start_date, then only events on that day are returned.
array
Array of attributes to exclude. Possible values are ‘description’, ‘child_events’ and ‘assignment’
array
Array of optional attributes to include. Possible values are ‘web_conference’ and ‘series_natural_language’
integer
Number of calendar events to return per page (max 100).
boolean
Defaults to false (uses start_date, end_date, and undated criteria). If true, all events are returned, ignoring start_date, end_date, and undated criteria.
string
Only return events since the start_date (inclusive). Defaults to today. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ.
boolean
Defaults to false. If true, only events with blackout date set to true will be returned.
array
List of context codes of courses, groups, users, or accounts whose events you want to see. If not specified, defaults to the current user (i.e personal calendar, no course/group events). Limited to 10 context codes, additional ones are ignored. The format of this field is the context type, followed by an underscore, followed by the context id. For example: course_42
boolean
Defaults to false. If true, only events with important dates set to true will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
Type of calendar item to filter by. Use ‘event’ for general calendar events or ‘assignment’ for assignments.
boolean
If true, only undated events will be returned. This filter is ignored if ‘all_events’ is true.
integer
required
The unique identifier for the Canvas user whose calendar events are to be listed.
string
The end date for filtering events, in ISO 8601 format (e.g., ‘YYYY-MM-DDTHH:MM:SSZ’ or ‘YYYY-MM-DD’). Events occurring on or before this date will be returned. This filter is ignored if ‘all_events’ is true.
array
Assignment attributes to exclude (e.g., ‘description’, ‘html_url’) if items are assignments. No effect on non-assignment events.
array
Optional related resources to include in the response (e.g., ‘submission’, ‘assignment_visibility’). E.g., ‘submission’ adds submission data for assignments.
integer
Number of calendar events to return per page (max 100).
boolean
If true, returns all calendar events for the user, overriding ‘start_date’, ‘end_date’, and ‘undated’ filters.
string
The start date for filtering events, in ISO 8601 format (e.g., ‘YYYY-MM-DDTHH:MM:SSZ’ or ‘YYYY-MM-DD’). Events occurring on or after this date will be returned. This filter is ignored if ‘all_events’ is true.
boolean
If true, retrieves only ‘blackout dates’ (e.g., dates when a course might be unavailable).
array
Context codes (e.g., ‘course_123’, ‘group_456’, ‘user_self’) to filter events by. If omitted, events from all contexts visible to the user are returned.
boolean
If true, retrieves only events marked ‘important_dates’ (e.g., course announcements with specific dates).
array
Submission types (e.g., ‘online_quiz’, ‘on_paper’) to filter by if item is an assignment. No effect if ‘type’ is not ‘assignment’.
array
Submission types to exclude if item is an assignment. No effect if ‘type’ is not ‘assignment’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
string
required
The unique identifier of the user to retrieve enabled features from. Use ‘self’ to refer to the currently authenticated user, or provide a numeric user ID.
integer
The number of feature names to return per page. If not specified, Canvas uses its default page size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of tools to return per page (max 100).
string
required
The unique identifier of the course to list external tools for.
string
The placement type to filter by (e.g., ‘editor_button’, ‘course_navigation’, ‘account_navigation’).
boolean
If true, then only tools that are meant to be selectable are returned.
string
The partial name of the tools to match and return.
boolean
If true, then include tools installed in all accounts above the current context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of poll sessions to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_COMM_MESSAGESRetrieves communication messages from Canvas.

Input Parameters

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
Identifier for the user whose messages are listed. Defaults to the authenticated user if omitted.
string
End of the time filter (inclusive), as an ISO 8601 timestamp. Includes messages sent on or before this time.
integer
Number of messages to return per page (max 100).
string
Start of the time filter (inclusive), as an ISO 8601 timestamp. Includes messages sent on or after this time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_COMMUNICATION_CHANNELSRetrieves a list of communication channels associated with a specific user in Canvas.

Input Parameters

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
required
The ID of the user for whom to list communication channels. Use ‘self’ for the current user, a numeric user ID, or a SIS User ID prefixed with ‘sis_user_id:’.
integer
Number of communication channels to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string ("live")
If set to ‘live’, returns only conferences that are live (i.e., have started and not finished yet). If omitted, returns all conferences for this user’s groups and courses.
integer
Number of conferences to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of content exports to return per page (max 100).
string
required
The unique identifier for the course. Can be a numeric ID or SIS ID. Returns 404 if the course does not exist or the user lacks permission to access it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
required
The unique identifier for the group. Can be a numeric ID or SIS ID. Returns 404 if the group does not exist or the user lacks permission to access it.
integer
Number of content exports to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to return (1-indexed). Defaults to 1 if not provided.
integer
The number of results to return per page (max 100). Defaults to 10 if not provided.
string
required
The unique identifier for the Canvas course. This is required to retrieve the list of content licenses available for the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
string
required
The unique identifier of the user whose content migrations are to be retrieved. This can be the numeric Canvas user ID or ‘self’ to represent the currently authenticated user.
integer
Number of content migrations to return per page. If not specified, Canvas default pagination is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
required
The unique identifier for the group. Can be a numeric ID or a SIS ID prefixed with ‘sis_group_id:’. Returns content migrations for this specific group.
integer
Number of content migrations to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
string ("unread" | "starred" | "archived" | "sent")
Scope filter for conversations.
array
When set, only return conversations for the specified courses, groups or users. The id should be prefixed with its type, e.g. ‘user_123’, ‘course_456’, ‘group_789’.
array
Optional list of additional data to include. ‘participant_avatars’: Optionally include an ‘avatar_url’ key for each user participating in the conversation. ‘uuid’: Optionally include an ‘uuid’ key for each user participating in the conversation.
integer
The number of conversations to return per page.
string
When filter[] contains multiple filters, combine them with this mode, filtering conversations that at have at least all of the contexts (‘and’) or at least one of the contexts (‘or’). Defaults to ‘or’.
boolean
(Obsolete) Submissions are no longer linked to conversations. This parameter is ignored.
boolean
Default is false. If true, the top-level element of the response will be an object rather than an array, and will have the keys ‘conversations’ which will contain the paged conversation data, and ‘conversation_ids’ which will contain the ids of all conversations under this scope/filter in the same order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Optionally include “ungraded_quizzes” to count ungraded quizzes (such as practice quizzes and surveys) in the list. These will be returned under a “quiz” key instead of an “assignment” key in response elements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_COURSE_BLACKOUT_DATESTool to retrieve the list of blackout dates for a Canvas course. Use when you need to check which dates are blocked for assignments in course pacing.

Input Parameters

string
required
The unique identifier for the Canvas course whose blackout dates are to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_COURSE_NICKNAMESTool to retrieve all course nicknames set by the current user. Use when you need to see all custom course name preferences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
array
Filter courses by workflow state. Only return courses in the given state(s). By default, ‘available’ is returned for students and observers, and anything except ‘deleted’ for all other enrollment types.
array
Optional additional data to include with each course. Multiple values can be specified.
integer
Number of courses to return per page. If omitted, Canvas default (10) is used. Set to a higher value (e.g., 100) to get more courses.
string
Deprecated. Filters courses by the specified course-level role. Can be a role created with the Add Role API or a base role type: ‘StudentEnrollment’, ‘TeacherEnrollment’, ‘TaEnrollment’, ‘ObserverEnrollment’, or ‘DesignerEnrollment’. This argument is ignored if enrollment_role_id is given.
string
Filters courses by the user’s enrollment type. If omitted, courses are not filtered by enrollment type.
string
Filters courses by the enrollment workflow state. This will respect section/course/term date overrides.
integer
Filters courses by the specified course-level role ID. Only return courses where the user is enrolled with the specified role.
boolean
When set to true, only return courses that are not configured as blueprint courses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
array
Optional additional data to include with each section. Allowed values: ‘students’ (if you have permission to view users or grades), ‘avatar_url’ (include avatar URLs for students), ‘enrollments’ (if ‘students’ is also included, returns section enrollment for each student), ‘total_students’ (returns total amount of active and invited students), ‘passback_status’ (include grade passback status), ‘permissions’ (include whether section grants :manage_calendar permission).
integer
Number of sections to return per page. If omitted, Canvas default (10) is used. Set to a higher value (e.g., 100) to get more sections.
string
required
The unique identifier for the Canvas course to retrieve sections for.
string
Search course sections for the term. Returns only matching results. Term must be at least 2 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
array
Filters courses by workflow state. Allowed values: ‘unpublished’, ‘available’, ‘completed’, ‘deleted’. Default behavior (when not specified) returns all courses except deleted ones.
array
Specifies additional details to include for each course. Allowed values: ‘needs_grading_count’, ‘syllabus_body’, ‘public_description’, ‘total_scores’, ‘current_grading_period_scores’, ‘term’, ‘account’, ‘course_progress’, ‘sections’, ‘storage_quota_used_mb’, ‘total_students’, ‘passback_status’, ‘favorites’, ‘teachers’, ‘observed_users’, ‘all_courses’, ‘permissions’, ‘course_image’, ‘banner_image’, ‘concluded’, ‘post_manually’.
string
required
The unique identifier of the user for whom to retrieve the list of courses.
boolean
If true, filters the results to include only homeroom courses. Set to false or omit to include all course types.
integer
Number of courses to return per page (max 100).
string
Filters the results to include only courses associated with the specified account ID. Use this to narrow down results to courses within a specific account.
string
Filters courses by the user’s enrollment state. Allowed values: ‘active’ (actively enrolled), ‘invited_or_pending’ (invited but not yet accepted), ‘completed’ (enrollment has been completed/finished). When not specified, returns courses in all enrollment states.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_COURSE_SUBGROUPSTool to retrieve a paginated list of immediate OutcomeGroup children of an outcome group in a course. Use when you need to explore the hierarchical structure of learning outcomes within a specific course.

Input Parameters

string
required
The unique identifier of the parent outcome group whose subgroups to list.
integer
Page number to fetch (1-indexed).
integer
Number of subgroups to return per page (max 100).
string
required
The unique identifier of the Canvas course containing the outcome group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination (1-indexed). Use to navigate through result pages. If omitted, returns the first page.
integer
Number of items per page (default: 10, max: ~100). Controls pagination size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_COURSE_TODO_ITEMSReturns the current user’s course-specific todo items. Use this to get assignments that need grading or submission for a specific course. For full documentation, see the API documentation for user todo items in the Users API.

Input Parameters

string
required
The unique identifier for the Canvas course to retrieve todo items for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page.
string ("username" | "last_login" | "email" | "sis_id")
The field to sort the list of users by. Results are sorted in ascending order.
array
Specifies additional details to include for each user in the response (e.g., ‘enrollments’, ‘avatar_url’).
string
If provided, the response will be paginated to the page where this specific user ID appears. Useful for finding a user within a large list.
integer
Number of users to return per page (max 100). Higher values fetch more data in a single request.
array
A list of user IDs to filter the results. Only users whose IDs are in this list will be returned.
string
required
The unique identifier for the Canvas course from which to list users.
string
A partial name or full ID to filter users. If provided, only users matching the search term will be returned.
string
Deprecated: Filters users by a specific course-level role name. Use enrollment_role_id instead for better precision.
array
Filters the list to include only users with the specified enrollment types (e.g., ‘student’, ‘teacher’).
array
Filters the list to include only users with the specified enrollment states (e.g., ‘active’, ‘invited’).
string
Filters the list to include only users enrolled with the specified course-level role ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
integer
The number of custom gradebook columns to return per page. If not specified, Canvas API default will be used.
string
required
The unique identifier of the course to retrieve custom gradebook columns from.
boolean
Include hidden parameters. Defaults to false if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_DISCUSSION_ENTRIESRetrieves paginated top-level discussion entries for a course discussion topic. Entries may include recent replies, but those do not necessarily include every reply.

Input Parameters

integer
Page number to retrieve (pagination).
integer
Number of entries to return per page (pagination).
string
required
The unique identifier of the discussion topic.
string
required
The unique identifier of the course containing the discussion topic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
A list of entry ids to retrieve. Entries will be returned in id order, smallest id first. If not provided, all entries may be returned subject to pagination.
integer
Page number to retrieve (pagination).
string
required
The unique identifier of the group containing the discussion topic.
integer
Number of entries to return per page (pagination).
string
required
The unique identifier of the discussion topic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_DISCUSSION_TOPICSRetrieves a paginated list of discussion topics or announcements for a specified course.

Input Parameters

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
Filters topics by a specific state. Only one state can be specified. Valid options: ‘locked’, ‘unlocked’, ‘pinned’, ‘unpinned’.
array
Specifies additional data to return for each discussion topic. Valid options: ‘all_dates’, ‘sections’, ‘sections_user_count’, ‘overrides’. Multiple options can be provided as a list of strings.
string
The criteria for ordering discussion topics. Defaults to ‘position’ if not specified. Valid options: ‘position’, ‘recent_activity’, ‘title’.
integer
Number of discussion topics to return per page (max 100).
integer
required
The unique identifier of the course for which to list discussion topics.
string
Filters topics based on a characteristic, typically read status. Use ‘unread’ to get only unread topics. Valid options: ‘all’, ‘unread’.
string
A search string to match against discussion topic titles. Returns topics with partially matching titles.
boolean
If true, retrieves only announcements; otherwise, retrieves discussion topics. Defaults to false.
boolean
If true, and the requester is a student, excludes topics that are locked by module progression. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string ("locked" | "unlocked" | "pinned" | "unpinned")
Filter options for discussion topic states.
array
Specifies additional data to return for each discussion topic. Multiple options can be provided. ‘all_dates’ includes all dates associated with graded discussions’ assignments. ‘sections’ includes course sections associated with the topic. ‘sections_user_count’ includes the number of users in each section or total users in the topic’s context. ‘overrides’ includes assignment overrides.
string
required
The unique identifier of the group for which to list discussion topics.
string ("position" | "recent_activity" | "title")
Ordering criteria for discussion topics.
integer
Number of discussion topics to return per page (max 100).
string ("all" | "unread")
Filter options for discussion topic read state.
string
The partial title of the discussion topics to match and return.
boolean
Return announcements instead of discussion topics. Defaults to false.
boolean
For students, exclude topics that are locked by module progression. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
integer
The number of feature names to return per page. If not specified, Canvas uses its default page size.
string
required
The unique identifier of the course to retrieve enabled features from. This can be a numeric ID or a course SIS ID (e.g., ‘sis_course_id:MATH101’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed).
array
Filter by custom or base course-level enrollment roles. Overrides type parameter if provided.
array
Filter by enrollment type. Returns all types if omitted.
array
Filter by enrollment state. Defaults to active and invited if omitted.
array
Include additional data in the response.
string
Filter by user ID (course/section queries only).
integer
Number of enrollments to return per page (max 100).
string
required
The ID of the context (course, section, or user) to list enrollments for.
array
Filter by SIS user IDs.
string ("course" | "section" | "user")
required
The context type for listing enrollments: ‘course’, ‘section’, or ‘user’.
array
Filter by SIS course IDs.
array
Filter by SIS account IDs.
array
Filter section enrollments by SIS section IDs.
string
Returns grades for specified grading period; otherwise returns full-course grades.
array
When combined with sis_user_id, restricts results to enrollments created from specified SIS import.
string
Returns enrollments for specified term (user enrollments path only). Accepts enrollment term ID or SIS ID with ‘sis_term_id:’ prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed).
array
Array of additional information to include. ‘overrides’ returns term start/end dates overridden for different enrollment types.
integer
Number of terms to return per page (max 100).
string
Filter terms by name. Returns only terms that match the given search keyword. Search is matched against term name.
string
required
The unique identifier for the account. Use ‘self’ for the current account or provide a specific account ID.
array
Filter terms by state. If not set, defaults to ‘active’. Use ‘all’ to retrieve all terms regardless of state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
A list of entry ids to retrieve. Entries will be returned in id order, smallest id first. If not provided, returns all entries.
integer
The page number to return (1-indexed). Defaults to 1 if not provided.
integer
The number of results to return per page (max 100). Defaults to 10 if not provided.
string
required
The unique identifier of the discussion topic.
string
required
The unique identifier of the course containing the discussion topic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the custom gradebook column to retrieve data for.
string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of entries to return per page (max 100).
string
required
The unique identifier of the course containing the custom gradebook column.
boolean
If true, hidden columns will be included in the result. If false or absent, only visible columns will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_ENTRY_REPLIESTool to retrieve replies for a specific discussion entry in a course. Use when needing to list all replies to a particular discussion entry.

Input Parameters

integer
Page number to retrieve (pagination).
string
required
The unique identifier of the discussion entry whose replies to retrieve.
integer
Number of replies to return per page (pagination).
string
required
The unique identifier of the discussion topic.
string
required
The unique identifier of the course containing the discussion topic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_ENVIRONMENT_FEATURESTool to return a hash of global feature options that pertain to the Canvas user interface. Use when you need to check which features are enabled in the Canvas environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_ENVIRONMENT_SETTINGSRetrieves global environment settings for the root Canvas account. Use when you need to access instance-wide configuration values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_EXTERNAL_FEEDS_FOR_GROUPTool to retrieve the paginated list of external RSS feeds for a group. Use when you need to discover what external feeds are configured to automatically create announcements in a group.

Input Parameters

integer
The page number to return (1-indexed). Defaults to 1 if not provided.
string
required
The unique identifier of the group to list external feeds for.
integer
The number of results to return per page (max 100). Defaults to 10 if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of external tools to return per page (max 100).
string
The placement type to filter by (e.g., ‘editor_button’, ‘course_navigation’, ‘account_navigation’).
string
required
The Canvas account ID to list external tools for. Use ‘self’ to refer to the current user’s account.
boolean
If true, then only tools that are meant to be selectable are returned.
string
The partial name of the tools to match and return.
boolean
If true, then include tools installed in all accounts above the current context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
integer
Number of courses to return per page. If omitted, Canvas default (10) is used. Set to a higher value (e.g., 100) to get more courses.
boolean
When set, only return courses that are not configured as blueprint courses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_FAVORITE_GROUPSRetrieves the paginated list of favorite groups for the current user. Use when you need to see which groups a user has favorited.

Input Parameters

integer
Page number for pagination (1-indexed).
integer
Number of groups per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_FEATURES_COURSESRetrieves all feature flags for a Canvas course. Use when checking which features are available or enabled for a specific course.

Input Parameters

string
required
The Canvas course ID whose features to list.
boolean
When true, feature flags that are enabled in a higher context and cannot be overridden will be omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to return (1-indexed). Defaults to 1 if not provided.
string
required
The Canvas user ID whose features to list. Use ‘self’ to refer to the authenticated user.
integer
The number of results to return per page (max 100). Defaults to 10 if not provided.
boolean
When true, feature flags that are enabled in a higher context and cannot be overridden will be omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_FILESFetches a page of file metadata for a specified Canvas course, with a next-page token for retrieving further results.

Input Parameters

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of files to return per page (max 100).
string
required
The unique Canvas identifier for the course whose files are to be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the folder whose files are to be listed.
array
Array of information to restrict to. Overrides include[]. Supported values: ‘names’ (only returns file name information).
string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string ("name" | "size" | "created_at" | "updated_at" | "content_type" | "user")
Allowed sort fields for listing files.
string ("asc" | "desc")
Allowed sort order values.
array
Array of additional information to include. Supported values: ‘user’ (the user who uploaded the file or last edited its content), ‘usage_rights’ (copyright and license information for the file).
integer
Number of files to return per page (max 100).
string
The partial name of the files to match and return.
array
Filter results by content-type. You can specify type/subtype pairs (e.g., ‘image/jpeg’), or simply types (e.g., ‘image’, which will match ‘image/gif’, ‘image/jpeg’, etc.).
array
Exclude given content-types from your results. You can specify type/subtype pairs (e.g., ‘image/jpeg’), or simply types (e.g., ‘image’, which will match ‘image/gif’, ‘image/jpeg’, etc.).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_FOLDERSRetrieves a list of immediate sub-folders within the specified folder_id.

Input Parameters

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of folders to return per page (max 100).
string
required
ID of the parent folder for which to list direct sub-folders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_GLOBAL_SUBGROUPSTool to retrieve a paginated list of immediate OutcomeGroup children of a global outcome group. Use when you need to explore the hierarchical structure of global learning outcomes.

Input Parameters

string
required
The unique identifier of the global outcome group whose subgroups to list.
integer
Page number to fetch (1-indexed).
integer
Number of subgroups to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_GRADEABLE_STUDENTSTool to retrieve a paginated list of students eligible to submit a specific assignment. Use when you need to identify which students can submit work for grading. The caller must have permission to view grades in the course.

Input Parameters

integer
Page number for pagination (1-indexed). Use to get results beyond the first page.
string ("name")
Sort results by this field. Currently only ‘name’ is supported.
string ("asc" | "desc")
The sorting order. Defaults to ‘asc’ if not specified.
integer
Number of students to return per page (max 100). If omitted, Canvas default (10) is used.
string
required
The unique identifier for the Canvas course.
string
required
The unique identifier for the assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
integer
The number of grading periods to return per page.
string
required
The unique identifier of the course to retrieve grading periods for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
integer
Number of grading standards to return per page. If not specified, uses Canvas default pagination.
string
required
The unique identifier of the course to retrieve grading standards from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of group categories to return per page (max 100).
string
required
The unique identifier of the course to retrieve group categories from.
string ("all" | "collaborative" | "non_collaborative")
Filter group categories by their collaboration state. Options: ‘all’ (both collaborative and non-collaborative), ‘collaborative’ (default), or ‘non_collaborative’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to retrieve (pagination).
string
required
The unique identifier of the discussion entry whose replies to retrieve.
string
required
The unique identifier of the group containing the discussion topic.
integer
Number of replies to return per page (pagination).
string
required
The unique identifier of the discussion topic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
required
The unique identifier of the group to list external tools for.
integer
Number of tools to return per page (max 100).
string
The placement type to filter by (e.g., ‘editor_button’, ‘course_navigation’, ‘account_navigation’).
boolean
If true, then only tools that are meant to be selectable are returned.
string
The partial name of the tools to match and return.
boolean
If true, then include tools installed in all accounts above the current context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Array of information to restrict to. Overrides include[]. ‘names’ only returns file name information.
string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string ("name" | "size" | "created_at" | "updated_at" | "content_type" | "user")
Sort field options for file listing.
string ("asc" | "desc")
Sort order options.
array
Array of additional information to include. ‘user’ includes the user who uploaded the file or last edited its content.
string
required
The unique Canvas identifier for the group whose files are to be listed.
integer
Number of files to return per page (max 100).
string
The partial name of the files to match and return.
array
Filter results by content-type. You can specify type/subtype pairs (e.g., ‘image/jpeg’), or simply types (e.g., ‘image’, which will match ‘image/gif’, ‘image/jpeg’, etc.).
array
Exclude given content-types from your results. You can specify type/subtype pairs (e.g., ‘image/jpeg’), or simply types (e.g., ‘image’, which will match ‘image/gif’, ‘image/jpeg’, etc.).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_GROUP_MEMBERSHIPSTool to retrieve a paginated list of members in a Canvas group. Use when you need to query group memberships with optional workflow state filters.

Input Parameters

integer
Page number to fetch (1-indexed).
string
required
The unique identifier of the group to list memberships for.
integer
Number of memberships to return per page (max 100).
array
Filter memberships by workflow state. Returns all memberships by default if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed).
array
Include additional data in the response. ‘tabs’ includes the list of tabs configured for each group.
integer
Number of groups to return per page (max 100).
string
required
The unique identifier of the course to list groups from.
boolean
If true, only includes groups that the user belongs to.
string ("all" | "collaborative" | "non_collaborative")
Collaboration state filter for groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
array
Additional information to include in the response. Currently supports ‘tabs’ to include the list of tabs configured for each group.
integer
Number of groups to return per page (max 100).
string
required
The ID of the account to retrieve groups for. Use ‘self’ for the current user’s root account.
boolean
If true, only include groups that the user belongs to. If false or omitted, returns all visible groups in the account.
string ("all" | "collaborative" | "non_collaborative")
Filter groups by collaboration state. ‘all’ returns both collaborative and non-collaborative groups, ‘collaborative’ returns only collaborative groups (default if not specified), ‘non_collaborative’ returns only non-collaborative groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_GROUPS_USERSRetrieves a paginated list of users in a Canvas group. Use when you need to see all members of a specific group.

Input Parameters

integer
Page number for pagination (1-indexed).
array
Additional data to include in the response. Use ‘avatar_url’ to include users’ avatar URLs.
string
required
The unique identifier of the Canvas group to retrieve users from.
integer
Number of users per page (max 100).
string
The partial name or full ID of the users to match and return in the results list. Must be at least 2 characters.
boolean
Whether to filter out inactive users from the results. If not specified, defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to return (1-indexed). Defaults to 1 if not provided.
string
required
The identifier of the user for which to retrieve content licenses. Use ‘self’ for the current authenticated user or provide a specific user ID.
integer
The number of results to return per page (max 100). Defaults to 10 if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_LICENSES_GROUPSRetrieves content licenses available for a specific Canvas group’s content.

Input Parameters

string
required
The unique identifier for the Canvas group. This is required to retrieve the list of content licenses available for the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the outcome group.
integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
integer
The number of outcomes to return per page. If omitted, uses Canvas default pagination.
string
required
The unique identifier of the Canvas account.
string
The detail level of the outcomes. Defaults to “abbrev”. Specify “full” for more information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the outcome group.
integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
integer
The number of outcomes to return per page. If omitted, uses Canvas default pagination.
string
required
The unique identifier of the Canvas course.
string
The detail level of the outcomes. Defaults to “abbrev”. Specify “full” for more information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of launch definitions to return per page (max 100).
string
required
The Canvas course ID to list LTI launch definitions for.
array
The placements to return launch definitions for. If not provided, an empty list will be returned. Common placements include: ‘course_navigation’, ‘account_navigation’, ‘editor_button’, ‘assignment_selection’, ‘link_selection’, ‘global_navigation’, ‘user_navigation’, ‘homework_submission’, ‘migration_selection’, ‘tool_configuration’, ‘resource_selection’, ‘post_grades’, ‘submission_type_selection’.
boolean
If true, only return launch definitions that are visible to the current user. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of accounts to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string ("title" | "created_at")
Sort field options for media objects.
string ("asc" | "desc")
Sort order options.
array
Array of data to exclude. By excluding ‘sources’ and ‘tracks’, the API will not need to query Kaltura, which greatly speeds up its response. ‘sources’ excludes media_sources, ‘tracks’ excludes media_tracks.
integer
Number of media objects to return per page (max 100).
string
required
The unique identifier of the course for which to retrieve media attachments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string ("title" | "created_at")
Sort field options for media objects.
string ("asc" | "desc")
Sort order options.
array
Array of data to exclude. By excluding ‘sources’ and ‘tracks’, the API will not need to query Kaltura, which greatly speeds up its response. ‘sources’ excludes media_sources, ‘tracks’ excludes media_tracks.
integer
Number of media objects to return per page (max 100).
string
required
The unique identifier of the course for which to retrieve media objects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string ("title" | "created_at")
Sort field options for media objects.
string ("asc" | "desc")
Sort order options.
array
Array of data to exclude. By excluding ‘sources’ and ‘tracks’, the API will not need to query Kaltura, which greatly speeds up its response. ‘sources’ excludes media_sources, ‘tracks’ excludes media_tracks.
string
required
The unique identifier of the group for which to retrieve media attachments.
integer
Number of media objects to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string ("title" | "created_at")
Sort field options for media objects.
string ("asc" | "desc")
Sort order options.
array
Array of data to exclude. By excluding ‘sources’ and ‘tracks’, the API will not need to query Kaltura, which greatly speeds up its response. ‘sources’ excludes media_sources, ‘tracks’ excludes media_tracks.
string
required
The unique identifier of the group for which to retrieve media objects.
integer
Number of media objects to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string ("title" | "created_at")
Sort field options for media objects.
string ("asc" | "desc")
Sort order options.
array
Array of data to exclude. By excluding ‘sources’ and ‘tracks’, the API will not need to query Kaltura, which greatly speeds up its response. ‘sources’ excludes media_sources, ‘tracks’ excludes media_tracks.
integer
Number of media objects to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
required
The unique identifier for the user. Can be a numeric ID, SIS ID prefixed with ‘sis_user_id:’, or ‘self’ for the currently authenticated user.
integer
Number of migration issues to return per page (max 100).
string
required
The unique identifier for the content migration. This is the ID of the migration for which to retrieve issues.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the Canvas group. Can be a numeric ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the user. Use ‘self’ to refer to the authenticated user, or provide a numeric user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
array
Filter the results. ‘submittable’ returns only assignments that the current user can submit (filters out locked assignments). ‘current_grading_period’ returns only missing assignments in the current grading period.
array
Optionally include additional data. ‘planner_overrides’ includes the assignment’s associated planner override if it exists. ‘course’ includes the assignments’ courses.
string
The ID of the user to retrieve missing submissions for. Use ‘self’ for the currently authenticated user, or provide a numeric user ID. The user making the request must either be the student, an admin, or a parent observer.
integer
Number of items to return per page for pagination.
array
Optionally restricts the list of past-due assignments to only those associated with the specified course IDs. Required if observed_user_id is passed.
string
Return missing submissions for the given observed user. Must be accompanied by course_ids. The user making the request must be observing the observed user in all the courses specified by course_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
array
Optional array to include additional details. When ‘content_details’ is included, returns content-specific details (points_possible, due_at, unlock_at, lock_at, locked_for_user) and standard lock information for each item.
integer
The number of items to return per page. If not specified, Canvas API default applies (typically 10).
string
required
The unique identifier of the Canvas course containing the module.
string
required
The unique identifier of the module whose items to retrieve.
string
Returns module completion information for the student with this id. Allows viewing progress for a specific student.
string
The partial title of the items to match and return. Filters results to items whose titles contain this search term.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
array
Additional data to include with each module. Options: ‘items’ returns module items inline if possible (Canvas may omit items if too numerous), ‘content_details’ requires ‘items’ and returns additional details specific to content items including standard lock information.
integer
The number of modules to return per page. If omitted, uses Canvas default pagination.
string
required
The unique identifier of the Canvas course to retrieve modules from. This is REQUIRED.
string
Returns module completion information for the student with this id. Use this to see completion status for a specific student.
string
The partial name of the modules (and module items, if ‘items’ is specified with include) to match and return. Use this to filter modules by name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_MY_ADMIN_ROLESRetrieves a paginated list of the current user’s admin roles in a Canvas account. A 403 or 404 response is returned as an empty list, so an empty result does not necessarily mean the user has no roles.

Input Parameters

integer
The page number to return (1-indexed). Defaults to 1 if not provided.
integer
The number of results to return per page (max 100). Defaults to 10 if not provided.
string
required
The ID of the account to list admin roles for. Use ‘1’ for the root account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the user. Use ‘self’ for the current user, a numeric user ID, or a SIS User ID prefixed with ‘sis_user_id:’.
string
required
The ID of the communication channel for which to fetch notification preference categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The communication channel type (e.g., ‘email’, ‘sms’, ‘push’).
string
required
The channel address corresponding to the type. For email type, this is an email address (e.g., ‘alice@rolai.com’). For sms type, this is a phone number.
string
required
The ID of the user whose notification preferences are being retrieved. Use ‘self’ for the current user, a numeric user ID, or a SIS User ID prefixed with ‘sis_user_id:’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
array
Additional information to include in the response. Supported value: ‘avatar_url’ to include the observee’s avatar URL.
string
required
The unique identifier of the user for whom to retrieve observees. Use ‘self’ to list observees for the authenticated user. Administrators can specify any user ID to list observees for other users.
integer
Number of observees to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
array
Optional list of additional data to include. Currently supports ‘avatar_url’ to include the observer’s avatar URL.
string
required
The ID of the user whose observers to list. Use ‘self’ to list observers of the current authenticated user.
integer
Number of observers to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of poll sessions to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
The field to sort the list of pages by. Valid values are: ‘title’, ‘created_at’, or ‘updated_at’.
string
The order in which to sort the results. Valid values are: ‘asc’ for ascending order or ‘desc’ for descending order. Defaults to ‘asc’ if not specified.
array
Optional array of additional data to include in the response. Currently supports ‘body’ to include the full HTML content of each page. For example: [‘body’]
integer
Number of pages to return per page (max 100).
string
required
The unique identifier for the course for which to list pages.
boolean
Filter pages by published status. Set to true to include only published pages, false to exclude published pages, or omit to show all pages regardless of published status.
string
The partial title of the pages to match and return. Use this to filter pages by searching for text in their titles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string ("title" | "created_at" | "updated_at")
Allowed sort field values for listing pages.
string ("asc" | "desc")
Allowed sort order values.
array
Optionally include the page body with each Page. If this is a block_editor page, returns the block_editor_attributes.
string
required
The unique identifier for the group for which to list pages.
integer
Number of pages to return per page (max 100).
boolean
If true, include only published pages. If false, exclude published pages. If not present, do not filter on published status.
string
The partial title of the pages to match and return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page bookmark token from a previous response’s next_page field. Canvas planner API uses bookmark-based pagination with opaque tokens. Do not pass arbitrary values - only use tokens returned in previous responses. If omitted, returns the first page.
string
Filter to apply to planner items. Use ‘new_activity’ to return only items with new or unread activity, or ‘incomplete_items’ to exclude completed items.
string
User ID to retrieve planner items for. If omitted or set to ‘self’, retrieves items for the current authenticated user. Use an integer user ID to retrieve items for a specific user.
string
Only return items with a due date on or before this date. Format: ‘yyyy-mm-dd’ or ISO 8601 datetime string (e.g., ‘2024-12-31’ or ‘2024-12-31T23:59:59Z’). Strongly recommended for date-window queries.
integer
Number of items to return per page for pagination.
string
Only return items with a due date on or after this date. Format: ‘yyyy-mm-dd’ or ISO 8601 datetime string (e.g., ‘2024-01-01’ or ‘2024-01-01T00:00:00Z’). Strongly recommended for date-window queries.
array
Array of context codes to filter by (e.g., ‘course_42’, ‘group_123’). If omitted, defaults to all contexts visible to the user.
integer
For observers: retrieve planner items for an observed student. Requires context_codes parameter to be specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
string
Only return notes with todo dates before the end_date (inclusive). Format: ‘yyyy-mm-dd’ or ISO 8601 ‘YYYY-MM-DDTHH:MM:SSZ’. If end_date and start_date are both specified and equivalent, only notes with todo dates on that day are returned.
integer
Number of planner notes to return per page for pagination.
string
Only return notes with todo dates since the start_date (inclusive). Format: ‘yyyy-mm-dd’ or ISO 8601 ‘YYYY-MM-DDTHH:MM:SSZ’.
array
List of context codes of courses whose notes you want to see. Format: context_type + ’_’ + context_id (e.g., ‘course_42’, ‘user_1’). If not specified, defaults to all contexts that the user belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
integer
Number of planner overrides to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
string
required
The unique identifier of the poll to retrieve choices from.
integer
The number of poll choices to return per page. If not specified, Canvas API default will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
integer
The number of polls to return per page. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
required
The unique identifier of the poll to retrieve sessions for.
integer
Number of poll sessions to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the user whose notification preferences are being listed. Use ‘self’ for the current user, a numeric user ID, or a SIS User ID prefixed with ‘sis_user_id:’.
string
required
The ID of the communication channel for which to fetch notification preferences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number for paginated results, starting from 1. If not specified, the first page is returned.
string
required
The unique identifier of the quiz to retrieve questions from.
integer
The number of questions to return per page. If not specified, Canvas default will be used.
string
required
The unique identifier of the course containing the quiz.
integer
If specified, returns the questions that were presented for that submission. Useful if the quiz has been modified after the submission was created. NOTE: Must specify quiz_submission_attempt as well.
integer
The attempt of the submission you want the questions for. Required if quiz_submission_id is specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number for paginated results, starting from 1. If not specified, the first page is returned.
integer
The number of quizzes to return per page for paginated results. If not specified, a default number (e.g., 10) set by Canvas will be used.
string
required
The unique identifier of the course from which to list quizzes.
string
A partial title to filter quizzes. Only quizzes whose titles contain this term will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_RECEIVED_CONTENT_SHARESRetrieves a paginated list of content shares received by a specified Canvas user. Use ‘self’ as the user ID to retrieve your own received shares.

Input Parameters

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
string
required
The unique identifier of the user whose received content shares are to be retrieved. This can be the numeric Canvas user ID or a SIS ID prefixed with ‘sis_user_id:’. Use ‘self’ to represent the currently authenticated user.
integer
The number of content shares to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
required
The unique identifier of the user to retrieve history for. Use ‘self’ to retrieve history for the currently authenticated user, or an integer user ID for a specific user (requires observer or admin permissions).
integer
Number of history entries to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
required
The unique identifier for the Canvas group.
integer
Number of revisions to return per page (max 100).
string
required
The URL (e.g., ‘test-page-for-revisions’) or the numeric ID of the page. If a page URL might be identical to another page’s numeric ID, prefix the ID with ‘page_id:’ (e.g., ‘page_id:5678’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_ROLESLists roles in a Canvas account, with optional state and inherited-role filters. Returns one page of results.

Input Parameters

integer
The page number to return (1-indexed). Defaults to 1 if not provided.
array
Filters results by role state. Can include ‘active’, ‘inactive’, or both. Defaults to active roles only if not specified.
integer
The number of results to return per page (max 100). Defaults to 10 if not provided.
string
required
The identifier of the account for which to retrieve roles.
boolean
When set to true, includes all roles inherited from parent accounts. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed).
array
Filter by enrollment roles. Accepts course-level roles created via Add Role API and base enrollment types. Overrides type parameter if provided.
array
Filter by enrollment type. Returns all types if omitted. Ignored if role parameter is provided.
array
Filter by enrollment state. Defaults to active and invited if omitted. Some synthetic states are only supported when querying user enrollments.
array
Array of additional information to include on enrollment or user records. ‘avatar_url’ and ‘group_ids’ are returned on the user record. ‘current_points’ includes current_points and unposted_current_points in grades hash for student enrollments.
string
Filter by user_id. Only valid for course or section enrollment queries. If set to current user’s id, determines if user has any enrollments independent of roster view permissions.
integer
Number of enrollments to return per page (max 100).
string
required
The ID of the section to list enrollments for.
array
Returns only enrollments for specified SIS user ID(s). May pass array or string.
array
Returns only enrollments matching specified SIS course ID(s). May pass array or string.
array
Returns only enrollments for specified SIS account ID(s). Does not look into sub_accounts. May pass array or string.
array
Returns only section enrollments matching specified SIS section ID(s). May pass array or string.
string
Return grades for the given grading_period. If not specified, returned grades will be for the whole course.
boolean
If sis_user_id is present and created_for_sis_id is true, returns only enrollments for specified SIS ID(s). When user has two sis_id’s, this limits enrollments to those created from sis_import with that sis_user_id.
string
Returns only enrollments for specified enrollment term. Only applies to user enrollments path. May pass enrollment term ID or SIS id prepended with ‘sis_term_id:’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_SENT_CONTENT_SHARESRetrieves content shares sent by the specified user to other users or courses within Canvas.

Input Parameters

string
Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
string
required
The unique identifier of the user whose sent content shares are to be retrieved. This can be the numeric Canvas user ID or a SIS ID prefixed with ‘sis_user_id:’. Use ‘self’ to represent the currently authenticated user.
integer
Number of content shares to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page.
integer
Number of students to return per page (max 100). Higher values fetch more data in a single request.
string
required
The unique identifier for the Canvas course from which to list students.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_SUBGROUPSRetrieves the first page of immediate outcome subgroups for an account’s outcome group and may return a next-page number.

Input Parameters

string
required
The unique identifier of the outcome group whose subgroups will be listed.
string
required
The unique identifier of the account that owns the outcome group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_SUBMISSIONSFetches gradebook history submissions for a specific course, assignment, grader, and date from Canvas.

Input Parameters

string
required
The specific date for which to retrieve submission history, in ‘YYYY-MM-DD’ format. This refers to the date when grading events occurred. Use the gradebook history days endpoint to find dates with available history.
string
Page token or number to fetch. Use the next_page value from a previous response to get the next page of results.
integer
Number of submissions to return per page. Canvas default is 10.
string
required
The unique identifier for the course. You can obtain course IDs from the list courses endpoint.
string
required
The unique identifier for the grader (teacher/instructor) whose grading history you want to view. You can obtain grader IDs from the list course users endpoint.
string
required
The unique identifier for the assignment. You can obtain assignment IDs from the list assignments endpoint or from the gradebook history days endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_SUBMISSIONSFOR_MULTIPLE_ASSIGNMENTSRetrieves submissions from a Canvas course for specified assignments and/or students; the course must be accessible.

Input Parameters

integer
Page number to fetch (1-indexed). If omitted, returns the first page.
integer
Number of submissions to return per page. Canvas default is 10.
integer
required
The unique identifier for the Canvas course from which to retrieve submissions.
array
List of student identifiers to filter submissions. Accepts Canvas user IDs, SIS user IDs (e.g., ‘sis_user_id:S123’), or the special keyword ‘all’. If omitted, submissions for the current authenticated user are returned. Students can only retrieve their own submissions. Observers can only retrieve submissions for students they are associated with. The ‘all’ keyword retrieves submissions for all students in the specified course or section.
array
List of assignment identifiers (Canvas assignment IDs) for which to retrieve submissions. If this list is omitted or empty, submissions for all assignments in the course will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("id" | "graded_at")
Sort order for submissions. Defaults to ‘id’. Does not affect grouped mode results.
boolean
If set to true, the response will be grouped by student (user_id), with each entry containing a user_id, submissions array, and optionally total_scores. If false or omitted, the response is a flat array of submissions.
array
Additional associations to include in the response. Note: ‘total_scores’ requires the ‘grouped’ parameter to be true.
string
required
The unique identifier for the Canvas section from which to retrieve submissions.
boolean
If set to true, only include submissions for assignments that have post_to_sis enabled and user enrollments added through SIS.
array
List of student identifiers to filter submissions. Accepts Canvas user IDs, SIS user IDs (e.g., ‘sis_user_id:S123’), or the special keyword ‘all’. If omitted, submissions for the current authenticated user are returned. Students can only retrieve their own submissions. Observers can only retrieve submissions for students they are associated with. The ‘all’ keyword retrieves submissions for all students in the specified section.
string
Filter to only include submissions graded after this date/time. Must be ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Excludes ungraded submissions.
array
List of assignment identifiers (Canvas assignment IDs) for which to retrieve submissions. If this list is omitted or empty, submissions for all assignments in the section will be returned.
string ("submitted" | "unsubmitted" | "graded" | "pending_review")
Filter submissions by their current workflow state.
string ("ascending" | "descending")
Sort direction for submissions. Defaults to ‘ascending’. Does not affect grouped mode results.
string
Filter to only include submissions submitted after this date/time. Must be ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Excludes unsubmitted submissions.
string ("active" | "concluded")
Filter by enrollment state. If omitted, includes all enrollments except deleted ones.
integer
Filter submissions to those within a specific grading period. Requires grading periods to exist on the account.
boolean
When true (default), uses effective enrollment state. When false, uses workflow_state. Only applies when enrollment_state is also specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
integer
Number of activity items to return per page. If omitted, Canvas default (10) is used.
boolean
If true, will only return objects for courses the user is actively participating in. If false or omitted, returns activity from all courses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
array
Optional array of additional data to include. Use [“ungraded_quizzes”] to include ungraded quizzes (such as practice quizzes and surveys) in the list. These will be returned under a “quiz” key instead of an “assignment” key in response elements.
integer
Number of todo items to return per page for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_TOPIC_ENTRIESTool to retrieve paginated top-level entries in a group discussion topic. Use when needing to list discussion entries in a group. May respond with 403 Forbidden if the topic requires an initial post and the user has not posted.

Input Parameters

integer
Page number to retrieve (pagination).
string
required
The unique identifier of the group containing the discussion topic.
integer
Number of entries to return per page (pagination).
string
required
The unique identifier of the discussion topic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page token or number to fetch. Use the next_page value from a previous response to get the next page of results.
integer
ID of the user (student) to filter submission versions.
integer
Number of submission versions to return per page. Canvas default is 10.
boolean
If true, returns submission versions in ascending order by date (oldest first); defaults to descending (newest first).
string
required
ID of an existing course to fetch submission versions from.
integer
ID of the assignment to filter submission versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Page token or number to fetch. Use the next_page value from a previous response to get the next page of results.
integer
Number of events to return per page. Canvas default is 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the user. Can be a numeric ID or ‘self’ for the current user. Returns 404 if the user does not exist or the user lacks permission to access it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed).
array
Filter by custom or base course-level enrollment roles. Overrides type parameter if provided.
array
Filter by enrollment type. Returns all types if omitted. Ignored if role parameter is provided.
array
Filter by enrollment state. Defaults to active and invited if omitted. Synthetic states like current_and_invited are supported for user enrollments.
array
Include additional data in the response (e.g., avatar_url, group_ids).
string
required
The ID of the user to retrieve enrollments for. Use ‘self’ for the current user.
integer
Number of enrollments to return per page (max 100).
array
Filter by SIS user IDs.
array
Filter by SIS course IDs.
array
Filter by SIS account IDs. Does not look into sub-accounts.
array
Filter section enrollments by SIS section IDs.
string
Returns grades for specified grading period; otherwise returns full-course grades.
array
When combined with sis_user_id, restricts results to enrollments created from specified SIS import.
string
Returns enrollments for specified term. Accepts enrollment term ID (e.g. ‘789’) or SIS ID with ‘sis_term_id:’ prefix (e.g. ‘sis_term_id:ABC123’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Array of information to restrict to. Overrides include[]. ‘names’: only returns file name information.
string
Page token or number to fetch. Use the next_page value from a previous response to get the next page of results.
string ("name" | "size" | "created_at" | "updated_at" | "content_type" | "user")
Sort field options for file listing.
string ("asc" | "desc")
Sort order options.
array
Array of additional information to include. ‘user’: the user who uploaded the file or last edited its content. ‘usage_rights’: copyright and license information for the file.
string
required
The unique Canvas identifier for the user whose files are to be listed. Use ‘self’ for the current user.
integer
Number of files to return per page. Canvas default is 10.
string
The partial name of the files to match and return.
array
Filter results by content-type. You can specify type/subtype pairs (e.g., ‘image/jpeg’), or simply types (e.g., ‘image’, which will match ‘image/gif’, ‘image/jpeg’, etc.).
array
Exclude given content-types from your results. You can specify type/subtype pairs (e.g., ‘image/jpeg’), or simply types (e.g., ‘image’, which will match ‘image/gif’, ‘image/jpeg’, etc.).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_LIST_USER_LOGINSRetrieves the first page of user logins for a specified Canvas account. The response may include a next-page value, but this tool does not accept a page parameter.

Input Parameters

string
required
The unique identifier of the Canvas account for which to retrieve user logins.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed).
string
required
The unique identifier of the Canvas user for which to retrieve logins. Can be a numeric user ID or ‘self’ for the authenticated user.
integer
Number of logins to return per page (max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page.
string ("username" | "last_login" | "email" | "sis_id")
When set, sort the results of the search based on the given field.
array
Optionally include additional data with each user: ‘enrollments’ (includes current and invited enrollments with grades if permitted), ‘locked’ (enrollment locked status), ‘avatar_url’ (user avatar), ‘bio’ (user bio), ‘test_student’ (course’s Test Student if present), ‘custom_links’ (plugin-supplied custom links), ‘current_grading_period_scores’ (scores for current grading period), ‘uuid’ (user uuid).
string
If this parameter is given and it corresponds to a user in the course, the page parameter will be ignored and the page containing the specified user will be returned instead.
integer
Number of users to return per page (max 100).
array
If included, the course users set will only include users with IDs specified by the param. Note: this will not work in conjunction with the ‘user_id’ argument but multiple user_ids can be included.
string
required
The unique identifier for the Canvas course from which to list users.
string
The partial name or full ID of the users to match and return in the results list.
array
When set, only return users who are enrolled in the given section(s).
string
Deprecated. When set, only return users enrolled with the specified course-level role. This can be a role created with the Add Role API or a base role type of ‘StudentEnrollment’, ‘TeacherEnrollment’, ‘TaEnrollment’, ‘ObserverEnrollment’, or ‘DesignerEnrollment’.
array
When set, only return users where the user is enrolled as this type. ‘student_view’ implies include[]=test_student. This argument is ignored if enrollment_role is given.
array
When set, only return users where the enrollment workflow state is of one of the given types. ‘active’ and ‘invited’ enrollments are returned by default.
integer
When set, only return courses where the user is enrolled with the specified course-level role. This can be a role created with the Add Role API or a built_in role id with type ‘StudentEnrollment’, ‘TeacherEnrollment’, ‘TaEnrollment’, ‘ObserverEnrollment’, or ‘DesignerEnrollment’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Set this value to true if you wish only to search unassigned users in the group category.
string
The partial name or full ID of the users to match and return in the results list. Must be at least 3 characters.
string
required
The unique identifier of the group category from which to retrieve the list of users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to fetch (1-indexed). Use to get results beyond the first page. If omitted, returns the first page.
array
Include additional data in the response. Use ‘tabs’ to include the list of tabs configured for each group.
integer
Number of groups to return per page. If omitted, Canvas default is used.
string ("Account" | "Course")
Context type filter for groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_MARK_ALL_CONVERSATIONS_AS_READTool to mark all conversations as read for the current user. Use when you need to mark all conversation messages in the inbox as read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_MARK_ALL_ENTRIES_AS_READMarks a course discussion topic and all its entries as read for the current user.

Input Parameters

string
required
The unique identifier for the discussion topic whose entries should be marked as read.
string
required
The unique identifier for the course containing the discussion topic.
boolean
A boolean value to set all of the entries’ forced_read_state. No change is made if this argument is not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the group containing the discussion topic.
string
required
The unique identifier for the discussion topic whose entries should be marked as read.
boolean
A boolean value to set all of the entries’ forced_read_state. No change is made if this argument is not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the group containing the discussion topic.
string
required
The unique identifier for the discussion topic to mark as unread.
boolean
A boolean value to set all of the entries’ forced_read_state. No change is made if this argument is not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_MARK_ALL_TOPIC_AS_READMark the initial text of all discussion topics as read in a course. Use when you need to mark all discussion topics in a course as read for the current user.

Input Parameters

string
required
The unique identifier for the course containing the discussion topics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_MARK_ALL_TOPIC_AS_READ2Mark the initial text of all discussion topics as read in a group. Use when you need to mark all discussion topics in a group as read for the current user.

Input Parameters

string
required
The unique identifier for the group containing the discussion topics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_MARK_BULK_SUBMISSIONS_AS_READMarks multiple submissions in a Canvas course as read in a single operation.

Input Parameters

string
required
The unique identifier of the course containing the submissions.
array
required
Array of submission IDs to mark as read. Each submission in the array will be marked as read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the section containing the submissions.
array
required
Array of submission IDs to mark as read. Each submission in the array will be marked as read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the user (student) whose submission annotations should be marked as read. Only the student who owns the submission can use this endpoint.
string
required
The unique identifier of the course containing the assignment.
string
required
The unique identifier of the assignment containing the submission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier for the user whose submission’s document annotations should be marked as read. Only the student who owns the submission can mark annotations as read.
string
required
Unique identifier for the section.
string
required
Unique identifier for the assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the discussion entry to mark as read.
string
required
The unique identifier of the group containing the discussion topic.
string
required
The unique identifier of the discussion topic containing the entry.
boolean
A boolean value to set the entry’s forced_read_state. No change is made if this argument is not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the discussion entry to mark as unread.
string
required
The unique identifier of the group containing the discussion topic.
string
required
The unique identifier of the discussion topic containing the entry.
boolean
A boolean value to set the entry’s forced_read_state. No change is made if this argument is not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_MARK_MODULE_ITEM_READTool to mark a module item as read, fulfilling the ‘must view’ requirement. Use when accessing external content directly without using the html_url redirect that normally fulfills view requirements.

Input Parameters

string
required
The unique identifier of the module item to mark as read.
string
required
The unique identifier of the course containing the module.
string
required
The unique identifier of the module containing the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the student whose submission’s rubric assessments should be marked as read. Only the student who owns the submission can mark it as read.
string
required
The unique identifier of the course containing the assignment.
string
required
The unique identifier of the assignment with the rubric assessment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the student whose submission’s rubric assessments should be marked as read. Use ‘self’ to mark the current authenticated user’s submission as read.
string
required
The unique identifier of the section containing the assignment.
string
required
The unique identifier of the assignment with the rubric assessment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_MARK_SUBMISSION_AS_READ_SECTIONSMarks a student’s submission as read for a specific assignment within a section. Use when you need to mark a submission as read in the context of a section rather than a course.

Input Parameters

string
required
The unique identifier of the user whose submission should be marked as read.
string
required
The unique identifier of the section containing the assignment.
string
required
The unique identifier of the assignment containing the submission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_MARK_SUBMISSION_AS_UNREADMarks a student’s submission as unread for a specific assignment. Use when you need to reset the read status of a submission to unread.

Input Parameters

string
required
The unique identifier of the user whose submission should be marked as unread.
string
required
The unique identifier of the course containing the assignment.
string
required
The unique identifier of the assignment containing the submission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_MARK_SUBMISSION_COMMENTS_READTool to mark submission comments as read in Canvas via GraphQL. Use when tracking which comments have been viewed or when updating read status for instructor feedback.

Input Parameters

string
required
The ID of the submission that the comments belong to. This is a required field.
array
required
Array of submission comment IDs to mark as read. This is a required field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_MARK_TOPIC_AS_READ_GROUPSMarks the initial text of a discussion topic as read for the current user in a group. Use when you need to flag a group discussion topic as read to indicate it has been reviewed.

Input Parameters

string
required
The unique identifier for the group containing the discussion topic.
string
required
The unique identifier for the discussion topic to mark as read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_MARK_TOPIC_AS_UNREAD_GROUPSMarks the initial text of a group discussion topic as unread for the current user. Use when you need to flag a group discussion topic as unread to track it for later review.

Input Parameters

string
required
The unique identifier for the group containing the discussion topic.
string
required
The unique identifier for the discussion topic to mark as unread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_NEW_QUIZ_ACCOMMODATIONS_SETEXPERIMENTAL: Sets quiz-level accommodations (extra time, extra attempts, reduced choices) for one or more students on a New Quiz. Sends a JSON array body; may return a partial success.

Input Parameters

string
required
The ID of the course containing the new quiz.
string
required
The assignment ID of the new quiz on which to set accommodations.
array
required
Array of accommodation objects, one per student. Sent as the JSON request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the course on which to set course-level accommodations.
array
required
Array of course-level accommodation objects, one per student. Sent as the JSON request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The title of the quiz.
string
Date/time (ISO 8601) when the quiz is due.
string
Date/time (ISO 8601) after which students can no longer submit.
string
required
The ID of the course where the new quiz will be created.
string
Date/time (ISO 8601) when the quiz becomes available.
string ("pass_fail" | "percent" | "letter_grade" | "gpa_scale" | "points")
How the quiz is graded: pass_fail, percent, letter_grade, gpa_scale, or points.
string
Instructions shown to students (HTML).
object
Nested settings controlling quiz behavior.
number
Total points possible for the quiz. Must be positive.
integer
The ID of the assignment group to associate this quiz with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_NEW_QUIZ_DELETEEXPERIMENTAL: Permanently deletes the New Quiz identified by assignment_id from the course identified by course_id; this action cannot be undone.

Input Parameters

string
required
The ID of the course containing the new quiz.
string
required
The assignment ID of the new quiz to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_NEW_QUIZ_GETEXPERIMENTAL: Retrieves a single New Quiz from a Canvas course by its assignment ID. Use when you need to view settings, dates, instructions, or other metadata for a New Quiz.

Input Parameters

string
required
The unique identifier of the course containing the new quiz.
string
required
The assignment ID linked to the new quiz to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_NEW_QUIZ_ITEM_CREATEEXPERIMENTAL: Creates a new QuestionItem in a New Quiz. The entry object describes the question body, interaction type, scoring, and feedback.

Input Parameters

object
required
The question entry with body, interaction data, scoring data, and feedback.
integer
Position of the item in the quiz (1-based).
string
required
The ID of the course containing the new quiz.
string ("Item")
Type of entry. Must be ‘Item’ for QuestionItems.
object
Top-level item properties object.
string
required
The assignment ID of the new quiz to which the item will be added.
number
Points possible for this item. Must be positive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_NEW_QUIZ_ITEM_DELETEEXPERIMENTAL: Permanently deletes a single quiz item (question) from a New Quiz; this action cannot be undone.

Input Parameters

string
required
The ID of the quiz item (question) to permanently delete.
string
required
The ID of the course containing the new quiz.
string
required
The assignment ID of the new quiz containing the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_NEW_QUIZ_ITEM_GETEXPERIMENTAL: Retrieves a single quiz item (question) from a New Quiz. Use to inspect item body, scoring, and interaction data.

Input Parameters

string
required
The ID of the quiz item (question) to retrieve.
string
required
The ID of the course containing the new quiz.
string
required
The assignment ID of the new quiz containing the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_NEW_QUIZ_ITEM_LISTEXPERIMENTAL: Lists all items (questions) in a New Quiz. Use to enumerate items with their positions, points, and question data.

Input Parameters

string
required
The ID of the course containing the new quiz.
string
required
The assignment ID of the new quiz whose items will be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_NEW_QUIZ_ITEM_MEDIA_UPLOAD_URLEXPERIMENTAL: Retrieves a presigned URL that can be used to upload media (images, audio, etc.) for use in New Quiz items.

Input Parameters

string
required
The ID of the course containing the new quiz.
string
required
The assignment ID of the new quiz for which to obtain a media upload URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_NEW_QUIZ_ITEM_UPDATEEXPERIMENTAL: Updates an existing quiz item (question) in a New Quiz. All body fields are optional; only supplied fields are modified.

Input Parameters

object
Question entry with body, interaction data, scoring data, and feedback. All sub-fields optional on update.
string
required
The ID of the quiz item (question) to update.
integer
Position of the item in the quiz (1-based).
string
required
The ID of the course containing the new quiz.
string ("Item")
Type of entry. Must be ‘Item’ for QuestionItems.
object
Top-level item properties object.
string
required
The assignment ID of the new quiz containing the item.
number
Points possible for this item. Must be positive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_NEW_QUIZ_LISTEXPERIMENTAL: Lists all New Quizzes in a Canvas course. Use to enumerate New Quizzes along with their settings and metadata.

Input Parameters

string
required
The unique identifier of the course whose new quizzes will be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("csv" | "json")
required
Output format for the report file: ‘csv’ or ‘json’.
string
required
The ID of the course containing the new quiz.
string ("student_analysis" | "item_analysis")
required
Type of report to generate. ‘student_analysis’ gives per-student performance; ‘item_analysis’ gives per-item statistics.
string
required
The assignment ID of the new quiz for which to generate a report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_NEW_QUIZ_UPDATEEXPERIMENTAL: Updates an existing New Quiz in a Canvas course. All body fields are optional; only supplied fields are modified.

Input Parameters

string
The title of the quiz.
string
Date/time (ISO 8601) when the quiz is due.
string
Date/time (ISO 8601) after which students can no longer submit.
string
required
The ID of the course containing the new quiz.
string
Date/time (ISO 8601) when the quiz becomes available.
string ("pass_fail" | "percent" | "letter_grade" | "gpa_scale" | "points")
How the quiz is graded: pass_fail, percent, letter_grade, gpa_scale, or points.
string
Instructions shown to students (HTML).
string
required
The assignment ID of the new quiz to update.
object
Nested settings controlling quiz behavior.
number
Total points possible for the quiz. Must be positive.
integer
The ID of the assignment group to associate this quiz with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether to only post grades for graded submissions. If true, only submissions with grades will be posted; if false or omitted, all submissions will be posted.
array
required
List of section IDs to post grades for. Must contain at least one section ID.
string
required
The ID of the assignment to post grades for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The body of the entry. Supports HTML formatting.
string
required
The unique identifier of the Canvas group.
string
required
The unique identifier of the discussion topic within the group.
string
A multipart/form-data form-field-style attachment. Attachments larger than 1 kilobyte are subject to quota restrictions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The body content of the reply to create. Supports HTML formatting.
string
required
The unique identifier for the discussion entry to which the reply will be posted.
string
required
The unique identifier for the Canvas group containing the discussion topic.
string
required
The unique identifier for the discussion topic within the group.
string
A multipart/form-data form-field-style attachment. Attachments larger than 1 kilobyte are subject to quota restrictions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The HTML content to process and sanitize for this course. This can include course-relative links and image references that will be converted to absolute URLs.
string
required
The unique identifier for the Canvas course where the HTML content will be processed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The HTML content to preview and process. Canvas will process this HTML according to group-specific settings and security policies.
string
required
Unique identifier of the Canvas group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the Progress object to query. This is typically returned when initiating an asynchronous operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("unrate" | "like")
required
A rating to set on this entry. Use ‘like’ (1) to rate positively or ‘unrate’ (0) to remove the rating.
string
required
The unique identifier for the discussion entry to rate.
string
required
The unique identifier for the group containing the discussion topic.
string
required
The unique identifier for the discussion topic containing the entry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_REDIRECT_TO_ASSIGNMENT_OVERRIDE_FOR_SECTIONTool to retrieve the assignment override for a specific section. Use when you need to fetch override details for a particular section’s assignment. Returns 404 if no override exists.

Input Parameters

string
required
Unique identifier for the assignment to retrieve the override for.
string
required
Unique identifier for the course section to retrieve the assignment override for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_REDIRECT_TO_ROOT_OUTCOME_GROUP_FOR_CONTEXTRetrieves the root outcome group for a specified account context. Use when you need to access the top-level outcome group hierarchy for an account.

Input Parameters

string
required
The unique identifier of the account for which to retrieve the root outcome group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_REMOVE_CONTENT_SHARETool to remove a content share from your list. Use ‘self’ as the user_id to remove your own content shares. Note that this endpoint does not delete other users’ copies of the content share.

Input Parameters

string
required
The unique identifier of the content share to remove.
string
required
The unique identifier of the user whose content share is to be removed. Use ‘self’ to represent the currently authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_REMOVE_COURSE_FROM_FAVORITESTool to remove a course from the current user’s favorites list. Use when you need to unfavorite a course for the authenticated user.

Input Parameters

string
required
The unique identifier of the course to remove from favorites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_REMOVE_COURSE_NICKNAMETool to remove the nickname for a specific course. Use when you need to clear a custom course name and revert to using the actual course name.

Input Parameters

string
required
The unique identifier of the course whose nickname should be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the feature flag to remove (e.g., ‘new_user_tutorial_on_off’). The flag must be defined directly on the specified user.
string
required
The unique identifier of the user from which to remove the feature flag. Use ‘self’ to refer to the current user. The flag must be defined directly on this user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_REMOVE_GROUP_FROM_FAVORITESTool to remove a group from the current user’s favorites. Use when you need to unfavorite a group for the authenticated user.

Input Parameters

string
required
The unique identifier of the group to remove from favorites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of file IDs to remove associated usage rights from. At least one file_id or folder_id must be provided.
string
required
The unique identifier of the group from which usage rights will be removed.
array
List of folder IDs. Usage rights will be removed from all files in these folders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the user from which usage rights will be removed. Use ‘self’ for the current user.
array
required
List of file IDs to remove associated usage rights from. At least one file_id or folder_id must be provided.
array
List of folder IDs. Usage rights will be removed from all files in these folders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of custom column IDs in the desired order. The IDs should be arranged in the sequence you want them to appear in the gradebook, from left to right.
string
required
The unique identifier of the course containing the custom gradebook columns to reorder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of pinned discussion topic IDs in the desired order. All pinned topics should be included.
string
required
The unique identifier of the group containing the pinned discussion topics to reorder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_REPLY_TO_DISCUSSION_ENTRYReplies to a discussion entry in a Canvas course, with optional attachments.

Input Parameters

string
required
The body content of the reply to create. Supports HTML formatting.
string
required
The unique identifier for the discussion entry to which the reply will be posted.
string
required
The unique identifier for the discussion topic within the course.
string
required
The unique identifier for the Canvas course containing the discussion topic.
array
A list of file attachment IDs to include with the reply, if any.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_RESET_COURSE_FAVORITESTool to reset the current user’s course favorites to the default automatically generated list of enrolled courses. Use when you need to restore default favorites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_RESET_GROUP_FAVORITESTool to reset the current user’s group favorites to the default automatically generated list of enrolled groups. Use when you need to clear custom group favorites and restore the default selection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
ID of the user whose folders to search. Use ‘self’ for the current authenticated user.
string
The full path to the folder, relative to the user’s root folder (e.g., ‘documents/assignments’). Do not include the root folder’s name. If empty or omitted, returns only the root folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the Canvas group. This ID must correspond to an existing group.
string
The full path to the folder relative to the group root folder. If empty or not provided, returns the root folder alone. Do not include the root folder’s name (e.g., ‘group files’). Example: ‘unfiled’ or ‘foo/bar/baz’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the quiz for which to retrieve all available reports.
string
required
The ID of the course containing the quiz.
boolean
Whether to retrieve reports that consider all the submissions or only the most recent. Defaults to false, ignored for item_analysis reports.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
An array of quiz IDs to filter the results. If omitted, overrides for all Classic Quizzes available to the operating user will be returned.
string
required
The unique identifier of the Canvas course to retrieve assignment overrides from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
An array of quiz IDs to filter the results. If omitted, overrides for all quizzes available to the operating user will be returned.
string
required
The unique identifier of the Canvas course to retrieve assignment overrides from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_RETRIEVE_ENROLLMENT_TERMRetrieves detailed information for a specific enrollment term within a given root account in Canvas.

Input Parameters

string
required
The unique identifier of the enrollment term to be retrieved from the specified account.
string
required
The unique identifier for the root account. Important: This must be the ID of a root-level account, not a sub-account, to avoid errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_RETRIEVE_INTERNAL_SETTINGTool to retrieve a single internal setting by ID or name from Canvas LMS using the GraphQL API. Use when you need to fetch configuration or system settings.

Input Parameters

string
The ID of the internal setting to retrieve. Either id or name must be provided.
string
The name of the internal setting to retrieve. Either id or name must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the Canvas group containing the page.
string
required
The URL (e.g., ‘test-wiki-page-created-by-api’) or the numeric ID of the page to revert.
string
required
The revision number to revert to. This will restore the page content to this historical version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Flag to mark the account calendars feature as seen by the user. Set to true to indicate the user has viewed this feature.
array
An array of account IDs to remember in the calendars list of the user. If not provided or empty, no account calendars will be enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The nickname to set for the course. Must be non-empty and shorter than 60 characters. This will replace the course’s name in API call outputs and selected Canvas UI locations.
string
required
The unique identifier for the Canvas course to set the nickname for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the quiz to set extensions for.
string
required
The ID of the course to set quiz extensions for.
array
required
List of quiz extensions to apply. Each extension specifies a user_id and the extension parameters (extra_time, extra_attempts, etc.).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("off" | "allowed" | "on")
required
The state to set for the feature flag. ‘off’: The feature is not available for the course. ‘allowed’: (valid only on accounts) The feature is off in the account, but may be enabled in sub-accounts and courses. ‘on’: The feature is turned on unconditionally for the course.
string
required
The name of the feature flag to set (e.g., ‘epub_export’, ‘analytics_2’, ‘encrypted_sourcedids’).
string
required
The unique identifier of the course for which to set the feature flag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("off" | "allowed" | "on")
required
The state to set for the feature flag. ‘off’: The feature is not available for the user. ‘allowed’: (valid only on accounts) The feature is off in the account, but may be enabled in sub-accounts and courses. ‘on’: The feature is turned on unconditionally for the user.
string
required
The name of the feature flag to set (e.g., ‘high_contrast’, ‘underline_all_links’).
string
required
The unique identifier of the user for which to set the feature flag. Use ‘self’ to refer to the currently authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the context (e.g., course, account) where the outcome is used.
string
required
The ID of the learning outcome to set friendly description for.
string
required
The friendly description text to set for the outcome. This provides a user-friendly explanation of the learning outcome.
string ("Account" | "Course")
required
The type of context - either ‘Course’ or ‘Account’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_SET_MODULE_ITEM_COMPLETIONTool to mark a module item as complete or incomplete in Canvas using the REST API. Use when tracking student progress or updating module item completion status. Uses PUT method to mark as done, DELETE method to mark as not done.

Input Parameters

boolean
required
Whether to mark the item as done (true) or not done (false).
string
required
The ID of the module item to mark as complete or incomplete.
string
required
The ID of the course containing the module.
string
required
The ID of the module containing the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_SET_OVERRIDE_STATUSSets or clears a custom grade override status for a student’s enrollment, optionally for a grading period. Omitting the custom grade status ID sends null to clear the status.

Input Parameters

string
required
The enrollment ID to set override status for.
string
Optional grading period ID to limit the override to a specific grading period.
string
The custom grade status ID to apply. Set to null to clear any existing custom grade status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether the file(s) or folder(s) should be published on save, provided that usage rights have been specified
array
required
List of IDs of files to set usage rights for. At least one file_id or folder_id must be provided.
string
required
The unique Canvas identifier for the group containing the files
array
List of IDs of folders to search for files to set usage rights for. Note that new files uploaded to these folders do not automatically inherit these rights.
object
required
Copyright and license information to apply to the files

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether the file(s) or folder(s) should be published on save, provided that usage rights have been specified. Set to true to publish on save.
string
required
The unique identifier of the user. Use ‘self’ for the current user.
array
required
List of file IDs to set usage rights for. At least one file_id or folder_id must be provided.
array
List of folder IDs. Usage rights will be set for all files in these folders. Note that new files uploaded to these folders do not automatically inherit these rights.
object
required
Copyright and license information to apply to the files

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the user (observer). Use ‘self’ to refer to the currently authenticated user.
string
required
The ID of the observee (the user being observed).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_SHOW_A_PLANNER_OVERRIDERetrieve a specific planner override for the current user. Use when you need to check the completion or dismissal status of a plannable item in the user’s planner.

Input Parameters

string
required
Unique identifier for the planner override to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_SHOW_CONTENT_EXPORTRetrieves information about a specific content export job for a course. Use this to check the status of an export and get the download URL when the export completes.

Input Parameters

string
required
The unique identifier for the content export to retrieve.
string
required
The unique identifier for the course. Can be a numeric ID or SIS ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_SHOW_EPUB_EXPORTTool to retrieve information about a single ePub export for a course. Use this to check the status of an export and get the download URL when the export completes.

Input Parameters

string
required
The unique identifier for the ePub export to retrieve.
string
required
The unique identifier for the course. Can be a numeric ID or SIS ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_SHOW_FRONT_PAGE_FOR_GROUPTool to retrieve the front page content for a specific Canvas group. Use when you need to access the main wiki page of a group.

Input Parameters

string
required
The unique identifier for the Canvas group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_SHOW_GROUP_CONTENT_EXPORTRetrieves information about a specific content export job for a group. Use this to check the status of an export and get the download URL when the export completes.

Input Parameters

string
required
The unique identifier for the content export to retrieve.
string
required
The unique identifier for the group. Can be a numeric ID or SIS ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
If set to true, exclude page content (body) from results and return only metadata.
string
required
The unique identifier for the Canvas group.
string
required
The URL (e.g., ‘test-page-for-revision-api’) or the numeric ID of the page. If a page URL might be identical to another page’s numeric ID, prefix the ID with ‘page_id:’ (e.g., ‘page_id:5678’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the outcome to retrieve.
boolean
If true, adds color and mastery level defaults to outcome ratings in the result. This will only take effect if the Account Level Mastery Scales feature flag is DISABLED.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the group containing the wiki page.
string
required
The URL (e.g., ‘test-page-for-api’) or the numeric ID of the page to retrieve. If a page URL might be identical to another page’s numeric ID, prefix the ID with ‘page_id:’ (e.g., ‘page_id:5678’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_SHOW_PLANNER_NOTERetrieve a specific planner note for the current user. Use when fetching details of a personal to-do item from the Canvas planner.

Input Parameters

string
required
The unique identifier of the planner note to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
If set to true, exclude page content from results and return only metadata.
string
required
The unique identifier for the group.
string
required
The unique identifier or URL slug of the page. Use the page ID (numeric) or the URL-safe version of the page title.
string
required
The unique identifier for the revision to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Unique identifier for the user. Use ‘self’ to get the authenticated user’s temporary enrollment status, or provide a specific user ID.
string
The ID of the account to check for temporary enrollment status. Defaults to the domain root account if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The user ID to retrieve. Can be a numeric user ID or ‘self’ for the current user.
array
Array of additional information to include. ‘locale’, ‘avatar_url’, ‘permissions’, ‘email’, and ‘effective_locale’ are always returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The type or name of the report to start. Use the ‘List Available Reports’ action or Canvas API documentation to get available report types.
string
required
The unique identifier for the Canvas account for which the report will be generated.
object
Parameters specific to the chosen report type (e.g., a ‘grade_export_csv’ might need courses[course_id]). Consult ‘List Available Reports’ or API documentation for parameter details. Omit if none are needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Submit the assignment as a URL. The URL scheme must be ‘http’ or ‘https’, no ‘ftp’ or other URL schemes are allowed. If no scheme is given (e.g. ‘www.example.com’) then ‘http’ will be assumed. Required when submission_type is ‘online_url’ or ‘basic_lti_launch’.
string
Submit the assignment as an HTML document snippet. Note this HTML snippet will be sanitized using the same ruleset as a submission made from the Canvas web UI. The sanitized HTML will be returned in the response as the submission body. Required when submission_type is ‘online_text_entry’.
integer
Submit on behalf of the given user. Requires grading permission.
array
Submit the assignment as a set of one or more previously uploaded files residing in the submitting user’s files section (or the group’s files section, for group assignments). Required when submission_type is ‘online_upload’.
string
required
The ID of the course containing the assignment.
string
Choose the time the submission is listed as submitted at. Requires grading permission. ISO 8601 format (e.g., ‘2026-02-13T10:30:00Z’).
string
Include a textual comment with the submission.
string
required
The ID of the assignment to submit.
boolean
Whether or not this comment should be sent to the entire group (defaults to false). Ignored if this is not a group assignment or if no text_comment is provided.
string ("online_text_entry" | "online_url" | "online_upload" | "media_recording" | "basic_lti_launch" | "student_annotation")
required
The type of submission being made. The assignment submission_types must include this submission type as an allowed option, or the submission will be rejected with a 400 error.
string
The media comment id to submit. Media comment ids can be submitted via this API, however, note that there is not yet an API to generate or list existing media comments, so this functionality is currently of limited use. Required when submission_type is ‘media_recording’.
string ("audio" | "video")
Enum for media comment types.
integer
The Attachment ID of the document being annotated. This should match the annotatable_attachment_id on the assignment. Required when submission_type is ‘student_annotation’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_SUBSCRIBE_TO_DISCUSSION_TOPICTool to subscribe or unsubscribe from a discussion topic to receive or stop receiving notifications. Use when managing discussion topic subscriptions via GraphQL.

Input Parameters

boolean
required
Whether to subscribe (true) or unsubscribe (false) to the discussion topic.
string
required
The ID of the discussion topic to subscribe to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_SUBSCRIBE_TO_TOPICSubscribe to a discussion topic to receive notifications about new entries. Use when you need to enable notifications for a specific discussion topic in a course.

Input Parameters

string
required
The unique identifier of the discussion topic to subscribe to.
string
required
The unique identifier of the course containing the discussion topic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_SUBSCRIBE_TO_TOPIC_IN_GROUPSubscribes to a group discussion topic to receive notifications about new entries. Returns a success indicator after a successful request.

Input Parameters

string
required
The unique identifier of the group containing the discussion topic.
string
required
The unique identifier of the discussion topic to subscribe to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Identifier for the Canvas course containing the file.
string
required
Identifier for a file reference, typically assigned during content import, used to find its current representation in the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UNSUBSCRIBE_FROM_TOPIC_IN_GROUPUnsubscribes from a group discussion topic to stop receiving notifications about new entries. Returns a success indicator after a successful request.

Input Parameters

string
required
The unique identifier of the group containing the discussion topic.
string
required
The unique identifier of the discussion topic to unsubscribe from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the content migration to update.
object
For course_copy_importer migrations, select objects to copy without using selective_import workflow. Keys are object types (e.g., ‘files’, ‘folders’, ‘pages’), values are lists of object ids.
string
required
The unique identifier for the Canvas user. Use ‘self’ for the current user.
object
Settings for content migration configuration.
object
Parameters for pre-uploading a file for content migration.
boolean
If true, perform a selective import instead of importing all content. The migration will identify contents and stop in ‘waiting_for_select’ state. Use the List items endpoint to enumerate contents, then call the Update endpoint with copy parameters to start import.
object
Date shifting options for migrated content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_A_MEMBERSHIPTool to accept a membership request or add/remove moderator rights for a group member. Use when you need to approve a user’s request to join a group or modify their moderator status.

Input Parameters

string
required
The unique identifier of the user whose membership to update.
string
required
The unique identifier of the group.
string
Set or remove moderator rights. No description provided by API.
string ("accepted")
Allowed workflow state for accepting membership requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the discussion entry to update. The entry must have been created by the current user, or the current user must have admin rights.
string
The updated body of the entry. Supports HTML formatting.
string
required
The unique identifier of the discussion topic within the course.
string
required
The unique identifier of the Canvas course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the planner override to update.
boolean
Whether the planner item is dismissed from the opportunities list. Set to true to dismiss, false to show in opportunities.
boolean
Whether the planner item is marked as completed. Set to true to mark as complete, false to mark as incomplete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Short title. Omit to keep existing.
boolean
Set True to publish; False for draft. Defaults to False if omitted.
string
Detailed description. Omit to keep existing.
array
Codes (e.g., ‘course_123’) linking to contexts like courses/groups. Omit to keep existing.
string
Location name (e.g., ‘Room 301’, ‘Online Zoom’). Omit to keep existing.
string
Physical/virtual address for location. Omit to keep existing.
array
Codes (e.g., ‘section_abc’) for sub-contexts like course sections. Omit to keep existing.
string
required
Unique identifier of the appointment group to update.
boolean
True allows observer sign-ups, False disallows. Omit to keep existing.
string ("private" | "protected")
Participant list visibility (‘private’ or ‘protected’). Omit to keep existing.
integer
Max participants per slot. Omit to keep existing.
integer
Max slots a user may book. Omit to keep existing.
integer
Min slots a user must book. Omit to keep existing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("immediately" | "daily" | "weekly" | "never")
required
The desired frequency for this notification. Determines how often notifications are sent through this communication channel.
string
required
The name of the notification to update (e.g., ‘alert’, ‘assignment_graded’, ‘course_content_changed’).
string
required
The ID of the communication channel to update the notification preference for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the bookmark to update.
string
The new URL that the bookmark should link to. If not provided, the existing URL will be preserved.
string
Optional additional data/metadata to update for the bookmark. If not provided, the existing data will be preserved.
string
The new name/title for the bookmark. If not provided, the existing name will be preserved.
integer
The new position of the bookmark in the list. Lower numbers appear first. If not provided, the existing position will be preserved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the calendar event to update.
string
Valid if the event whose ID is in the URL is part of a series. This defines the shape of the recurring event series after it’s updated. Its value is the iCalendar RRULE. Unending series are not supported.
string
Short title for the calendar event.
string ("one" | "all" | "following")
Specifies which events to update in a recurring series.
string
End date/time of the event (ISO 8601 ‘YYYY-MM-DDTHH:MM:SSZ’).
boolean
When true event is considered to span the whole day and times are ignored.
string
Start date/time of the event (ISO 8601 ‘YYYY-MM-DDTHH:MM:SSZ’).
string
Longer HTML description of the event.
string
Context code of the course, group, user, or account to move this event to. Scheduler appointments and events with section-specific times cannot be moved between calendars.
boolean
If the blackout_date is true, this event represents a holiday or some other special day that does not count in course pacing.
string
Location name of the event.
object
Section-specific start/end times. Keys are arbitrary identifiers; values are ChildEventData objects.
string
Location address
string
Time zone of the user editing the event. Allowed time zones are IANA time zones or Ruby on Rails time zones.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the comment bank item to update. Supports both legacy numeric IDs and GraphQL relay IDs.
string
required
The updated text content for the comment bank item. Must not be blank. This reusable comment can be used when grading assignments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_CONTENT_SHARETool to mark a Canvas content share as read or unread. Use when updating the read state of a content share.

Input Parameters

string
required
The unique identifier of the content share to update.
string
required
ID of the user who owns the content share; use ‘self’ for the authenticated user.
string ("read" | "unread")
required
Mark the content share as read or unread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("mark_as_read" | "mark_as_unread" | "star" | "unstar" | "archive" | "destroy")
required
Action to perform on the specified conversations. ‘mark_as_read’ marks conversations as read, ‘mark_as_unread’ marks as unread, ‘star’ adds a star, ‘unstar’ removes a star, ‘archive’ archives the conversations, and ‘destroy’ permanently deletes them.
array
required
List of conversation IDs to update. Maximum of 500 conversation IDs can be updated at once.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_COURSEUpdates an existing course, specified by its ID, with new attributes or triggers a lifecycle event like ‘conclude’ or ‘delete’.

Input Parameters

string
required
The ID of the course to update.
string
New name for the course.
string ("claim" | "offer" | "conclude" | "delete" | "undelete")
Lifecycle action for the course (e.g., ‘conclude’, ‘offer’, ‘delete’).
string
New end date in ISO8601 format.
string ("private" | "cc_by_nc_nd" | "cc_by_nc_sa" | "cc_by_nc" | "cc_by_nd" | "cc_by_sa" | "cc_by" | "public_domain")
New license for course content, defining usage.
string
ID of the academic term to associate with the course.
string
New start date in ISO8601 format.
boolean
If true, sets the course as a blueprint course.
boolean
If true, course is visible to all users (authenticated and unauthenticated).
string
The ID of the account to which the course will be reassigned.
string
New course code.
string ("feed" | "wiki" | "modules" | "syllabus" | "assignments")
Default landing page view when users navigate to the course.
string
HTML content for the course syllabus, replacing existing content.
boolean
If true, allows open enrollment where users can self-enroll without approval.
boolean
If true, syllabus is publicly visible to everyone.
boolean
If true, allows users to self-enroll, often via a URL or code.
string
Publicly visible description of course content or objectives.
boolean
If true, course members can add comments to wiki pages.
boolean
If true, course is visible only to authenticated users.
boolean
If true, API updates can override SIS-controlled fields; if false, updates to ‘sticky’ SIS fields are prevented.
boolean
If true, syllabus is visible only to authenticated users.
boolean
If true, enrolled students can edit wiki pages.
boolean
If true, students can attach files to forum posts.
boolean
If true, enrollment is restricted to the course’s start and end dates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_COURSE_SETTINGSUpdates various settings for an existing course in Canvas, identified by course_id.

Input Parameters

string
required
The unique identifier for the course whose settings are to be updated.
string
Sets the default due time for new assignments. This time will be pre-selected in the Canvas UI. Does not affect existing assignments. Format: HH:MM:SS (24-hour). Default is ‘23:59:59’. Use ‘inherit’ to use the account-level setting.
boolean
If true, hides the total grades in the student grades summary page.
boolean
If true, enables individual learning paths for students, allowing content to be released based on their performance on assessments or other criteria.
boolean
If true, requires copyright and license information to be provided for files before they can be published.
boolean
If true, disables comments on all course announcements.
boolean
If true (default), shows the course summary, including a list of assignments and calendar events, on the syllabus page.
boolean
If true, hides grade distribution graphs from students’ view.
boolean
If true, allows instructors to override the final grade for students for a grading period or the entire course.
boolean
If true, restricts students from viewing the course content after the official course end date.
integer
Specifies the maximum number of announcements to display on the home page when show_announcements_on_home_page is enabled. Only applicable if the home page is a Wiki.
boolean
If true, restricts students from viewing the course content before the official course start date.
boolean
If true, allows students to create and manage their own groups within the course.
boolean
If true, allows students to create new discussion topics.
boolean
If true, allows students to attach files to their discussion posts and replies.
boolean
If true, displays the most recent course announcements on the course home page. For Wiki home pages, this defaults to five announcements but can be configured via home_page_announcement_limit. This setting is ignored by Canvas for Elementary subjects.
boolean
If true, allows students to edit or delete their own discussion posts and replies.
boolean
If true, allows students to report discussion content they deem offensive or inappropriate.
boolean
If true, prevents students from viewing other students in sections they are not enrolled in on the course users page.
boolean
If true, SpeedGrader will be filtered to display students only from the currently selected group.
boolean
If true, allows students to create discussion topics anonymously.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The content for the front page in HTML format.
string
The title for the front page. NOTE: changing a page’s title will change its url. The updated url will be returned in the result.
string
required
The unique identifier for the Canvas group.
boolean
Whether the page is published (true) or draft state (false).
string ("teachers" | "students" | "members" | "public")
Which user roles are allowed to edit this page. Any combination of these roles is allowed (separated by commas): ‘teachers’ allows editing by teachers, ‘students’ allows editing by students, ‘members’ for group wikis allows editing by members of the group, ‘public’ allows editing by any user.
boolean
Whether participants should be notified when this page changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The hexadecimal color code to set for the specified asset_string. Should be in the format ‘#RRGGBB’ (e.g., ‘#FF5733’). If passing as a query parameter, do NOT include the ’#’ unless it is URL-escaped.
string
The unique identifier for the user. Use ‘self’ to update the authenticated user’s custom colors, or provide a specific user ID.
string
required
The asset string in the format ‘context_id’ (e.g., ‘course_42’). This identifies the specific context (course, group, etc.) for which to set the custom color.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the custom gradebook column to update.
string
The title/header text for the custom gradebook column.
boolean
If true, the column will not be displayed in the gradebook.
integer
The position of the column relative to other custom columns. Lower numbers appear first.
string
required
The unique identifier of the course containing the custom gradebook column.
boolean
If true, the column will not be editable in the gradebook UI.
boolean
If true, this column is designated as a teacher notes column. The gradebook only supports one teacher_notes column.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the course containing the custom gradebook columns.
array
required
Array of column data objects to update. Each object specifies a column_id, user_id, and content value. Setting content to empty string will delete the data object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_DISCUSSION_ENTRIES_READ_STATETool to update read state for discussion entries. Use when marking discussion entries as read or unread.

Input Parameters

boolean
required
Read state to set: true for marking as read, false for marking as unread.
array
required
List of discussion entry IDs to update read state for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_DISCUSSION_ENTRYTool to update an existing discussion entry in Canvas via GraphQL. Use when editing the message content or file attachments of a previously posted discussion entry.

Input Parameters

string
Associated file identifier.
string
Updated text content of the entry.
string
required
Required identifier for the discussion entry to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether to mark the discussion entry as read (true) or unread (false).
string ("liked" | "not_liked")
Rating to assign to the discussion entry. Use ‘liked’ to like the entry or ‘not_liked’ to unlike it.
boolean
Whether to force the read state. If true, the entry will remain in the specified state regardless of other factors.
string
required
The ID of the discussion entry participant to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether to mark the discussion topic as read (true) or unread (false). If not provided, the state is toggled.
string
required
The ID of the discussion topic to update read state for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_DISCUSSION_THREAD_READ_STATETool to update the read state of a discussion entry. Use when marking a discussion entry as read or unread.

Input Parameters

boolean
Whether to mark the discussion entry as read (true) or unread (false). If not provided, defaults to true.
string
required
The ID of the discussion entry to update read state for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_DISCUSSION_TOPICTool to update an existing discussion topic using the Canvas GraphQL API. Use when modifying the title or message of a discussion topic.

Input Parameters

string
The new title for the discussion topic.
string
The new message/body content for the discussion topic. Can include HTML formatting.
string
required
The ID of the discussion topic to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The new display name for the file. If this field is not provided or is null, the file’s current name will be preserved.
string
required
The unique identifier of the file to be updated.
string
Defines the action to take if a file with the specified 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.
string
ID of the folder to move the file to. Must be an existing folder in the same context as the file’s original parent. Ignored if the context lacks folders (e.g., root user files) or if null (file stays in current location).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the folder to be updated.
string
The new name of the folder.
boolean
Flag the folder as hidden.
boolean
Flag the folder as locked.
string
The datetime to lock the folder at (ISO 8601 format).
integer
Set an explicit sort position for the folder.
string
The datetime to unlock the folder at (ISO 8601 format).
string
The id of the folder to move this folder into. The new folder must be in the same context as the original parent folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the content migration to update.
object
Options for selective content copying during migration.
object
For course_copy_importer migrations, select objects to copy without using selective_import workflow. Keys are object types (e.g., ‘files’, ‘folders’, ‘pages’), values are lists of object ids.
string
required
The unique identifier for the Canvas group where the content migration exists.
object
Settings for content migration configuration.
object
Parameters for pre-uploading a file for content migration.
boolean
If true, perform a selective import instead of importing all content. The migration will identify contents and stop in ‘waiting_for_select’ state. Use the List items endpoint to enumerate contents, then call the Update endpoint with copy parameters to start import.
object
Date shifting options for migrated content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the discussion entry to update. The entry must have been created by the current user, or the current user must have admin rights.
string
The updated body of the entry. Supports HTML formatting.
string
required
The unique identifier of the Canvas group.
string
required
The unique identifier of the discussion topic within the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The type of communication channel (e.g., ‘email’, ‘sms’, ‘push’).
string
required
The address of the communication channel. For email type, this is an email address. For SMS, this is a phone number.
array
required
List of notification preferences to update. Each entry specifies a notification name and its desired frequency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the communication channel to update notification preferences for. This is the channel (e.g., email, SMS) where notifications are delivered.
object
required
Dictionary mapping notification names to their preference settings. Keys are notification identifiers (e.g., ‘assignment_due_date_changed’, ‘course_content_changed’). Each value specifies the desired frequency for that notification type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The Canvas course ID. Required when context_type is Course.
string ("immediately" | "daily" | "weekly" | "never")
required
How often notifications should be sent for this category.
string
The Canvas account ID. Required when context_type is Account.
string ("Course" | "Account")
required
The context type for the notification preference (Course or Account).
string ("Account_Notification" | "Announcement" | "Announcement_Created_By_You" | "Appointment_Availability" | "Appointment_Cancelations" | "Appointment_Signups" | "Calendar" | "All_Submissions" | "Late_Grading" | "Submission_Comment" | "Conversation_Message" | "Conversation_Created" | "Added_To_Conversation" | "Discussion" | "DiscussionEntry" | "DiscussionMention" | "ReportedReply" | "Due_Date" | "Grading" | "Grading_Policies" | "Invitation" | "Other" | "Content_Link_Error" | "Files" | "Membership_Update" | "Student_Appointment_Signups" | "Blueprint" | "Course_Content" | "Recording_Ready")
required
The notification category to update.
string
required
The ID of the communication channel to update preferences for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_PAGE_FOR_COURSEUpdates an existing wiki page in a Canvas course; if setting as front page, it must also be or be made published.

Input Parameters

string
New HTML content for the page body. Retains existing if None.
string
New title for the page. Retains existing if None.
string
required
Identifier of the course containing the page.
boolean
Publish or unpublish the page. Retains existing status if None.
string
required
URL (hyphenated string from title) or numeric ID of the page to update.
boolean
Set as course front page (must be published). Retains existing status if None.
string
Comma-separated list of roles (‘teachers’, ‘students’, ‘members’, ‘public’) allowed to edit. Retains existing if None.
boolean
Notify course participants of the update. Retains existing preference if None.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
New HTML content for the page body. If not provided, the existing body is retained.
string
New title for the page. NOTE: Changing a page’s title will change its URL. The updated URL will be returned in the result. If not provided, the existing title is retained.
string
required
Unique identifier for the group containing the page to update.
boolean
Whether the page is published (true) or draft state (false). If not provided, the existing status is retained.
string
required
The unique locator (URL slug) or numeric ID of the page to update. NOTE: If you pass a numeric value that does not represent an existing page ID, it will be interpreted as a URL and may fail.
boolean
Set an unhidden page as the front page (if true). The page must also be published to become the front page. If not provided, the existing status is retained.
string
Schedule a future date/time to publish the page in ISO 8601 format. This will have no effect unless the ‘Scheduled Page Publication’ feature is enabled in the account. If a future date is set and the page is already published, it will be unpublished.
string ("teachers" | "students" | "members" | "public")
Which user roles are allowed to edit this page. Any combination of these roles is allowed (separated by commas): ‘teachers’ (allows editing by teachers), ‘students’ (allows editing by students), ‘members’ (for group wikis, allows editing by members of the group), ‘public’ (allows editing by any user). If not provided, existing roles are retained.
boolean
Whether participants should be notified when this page changes. If not provided, the existing preference is retained.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the planner note to update.
string
The title of the planner note.
string
Text of the planner note. Can contain HTML formatting.
integer
The ID of the course to associate with the planner note. The caller must be able to view the course in order to associate it with a planner note. Use a null or empty value to remove a planner note from a course. Note that if the planner note is linked to a learning object, its course_id cannot be changed.
string
The date where this planner note should appear in the planner. The value should be formatted as: yyyy-mm-dd.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The type of communication channel (e.g., ‘email’, ‘sms’, ‘push’).
string
required
The address of the communication channel. For email type, this is an email address. For SMS, this is a phone number.
string ("immediately" | "daily" | "weekly" | "never")
required
The desired frequency for this notification. Determines how often notifications are sent through this communication channel.
string
required
The name of the notification to update (e.g., ‘alert’, ‘assignment_graded’, ‘course_content_changed’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_PREFERENCES_BY_CATEGORYChanges the notification frequency for a category on a single communication channel belonging to the authenticated user.

Input Parameters

string
required
The notification category to update (e.g., ‘announcement’, ‘due_date’, ‘grading’).
string ("immediately" | "daily" | "weekly" | "never")
required
How often notifications should be sent for this category.
string
required
The ID of the communication channel to update preferences for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the quiz submission to be updated.
integer
required
The specific attempt number of the quiz submission to update. The attempt must have been completed before scores can be updated.
string
required
The unique identifier for the quiz to which the submission belongs.
string
required
The unique identifier for the course to which the quiz submission belongs.
object
Scores and comments for individual questions. Keys are question IDs (as strings); values are objects with ‘score’ (float or null) and ‘comment’ (string or null) fields. Only specified questions will be updated; others remain unchanged.
number
A numerical value (positive or negative) used to manually adjust the total score of the quiz submission. This can be used for applying discretionary bonuses or penalties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_RUBRIC_ASSESSMENT_READ_STATETool to update rubric assessment read state for submissions in Canvas via GraphQL. Use when marking rubric assessments as read for specific submissions.

Input Parameters

array
required
List of submission IDs to update rubric assessment read state for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_SINGLE_POLLUpdates an existing poll belonging to the current user, supplying its question and optionally its description.

Input Parameters

string
required
The unique identifier of the poll to update.
array
required
Array containing poll update data. Typically contains a single poll update object with question and optional description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_SINGLE_POLL_CHOICETool to update an existing poll choice for a poll in Canvas. Use when you need to modify the text, correctness status, or position of a poll choice.

Input Parameters

string
required
The ID of the poll choice to update.
string
required
The ID of the poll containing the choice to update.
array
required
Array of poll choice objects to update. Typically contains one poll choice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_SINGLE_POLL_SESSIONTool to update an existing poll session for a poll in Canvas. Use when you need to modify a poll session’s attributes such as making results public or changing the associated course section.

Input Parameters

string
required
The unique identifier of the poll session to update.
string
required
The unique identifier of the poll containing the session to update.
integer
The id of the course this session is associated with.
integer
The id of the course section this session is associated with.
boolean
Whether or not results are viewable by students.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Whether to grade by question in SpeedGrader. When enabled, SpeedGrader will allow grading individual questions instead of submissions as a whole.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Whether to enable or disable the deeply nested alert for split screen view. Set to true to enable the alert, false to disable it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
required
The student-entered score value (what-if score). This is a hypothetical score that students can use to calculate potential grades.
string
required
The ID of the submission to update. This is the unique identifier for the student’s submission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_SUBMISSION_WHAT_IF_SCORETool to enter a what-if score for a submission and receive calculated grades. Grade calculation is costly, so use sparingly. Use when students want to test hypothetical scores to see their impact on overall grades.

Input Parameters

string
required
The unique identifier of the submission to update with a what-if score.
number
required
The hypothetical score the student wants to test to see calculated grades.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The new title for the discussion topic.
boolean
If true, this topic will be listed in the ‘Pinned Discussion’ section.
string
If a timestamp is given, the topic will be scheduled to lock at the provided timestamp. If the timestamp is in the past, the topic will be locked. Provide in ISO 8601 format.
string
The new message/body content for the discussion topic. Supports HTML formatting.
boolean
If true, thread will be expanded by default.
string
required
The unique identifier of the group containing the discussion topic.
string
required
The unique identifier of the discussion topic to update.
boolean
Whether this topic is published (true) or draft state (false). Only teachers and TAs have the ability to create draft state topics.
string
To create an assignment discussion, pass the assignment parameters as a sub-object. See the Create an Assignment API for the available parameters. The name parameter will be ignored, as it’s taken from the discussion title. If you want to make a discussion that was an assignment NOT an assignment, pass set_assignment = false as part of the assignment object.
string ("asc" | "desc")
Sort order for discussion entries.
boolean
If true, users will be allowed to rate entries.
boolean
If is_announcement and lock_comment are true, ‘Allow Participants to Comment’ setting is disabled.
string
By default, discussions are sorted chronologically by creation date. You can pass the id of another topic to have this one show up after the other when they are listed.
boolean
(DEPRECATED) If true, entries will be sorted by rating.
string
If a timestamp is given, the topic will not be published until that time. Provide in ISO 8601 format.
string ("side_comment" | "threaded" | "not_threaded")
The type of discussion.
boolean
If true, users cannot choose their preferred thread expansion setting.
boolean
If true, this topic is an announcement. It will appear in the announcement’s section rather than the discussions section. This requires announcement-posting permissions.
boolean
If true, the topic will have an associated podcast feed.
integer
If present, the topic will become a group discussion assigned to the group.
boolean
If true, users cannot choose their preferred sort order.
string
A comma-separated list of sections ids to which the discussion topic should be made specific to. If it is not desired to make the discussion topic specific to sections, then this parameter may be omitted or set to ‘all’. Can only be present only on announcements and only those that are for a course (as opposed to a group).
boolean
If true then a user may not respond to other replies until that user has made an initial reply.
boolean
If true, only graders will be allowed to rate entries.
boolean
If true, the podcast will include posts from students as well. Implies podcast_enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_USER_DISCUSSIONS_SPLITSCREEN_VIEWTool to update user discussions splitscreen view setting via Canvas GraphQL API. Use when enabling or disabling the splitscreen view for discussions.

Input Parameters

boolean
required
Boolean value to enable (true) or disable (false) splitscreen view for discussions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_UPDATE_USER_SETTINGSUpdates a Canvas user’s preferences for various interface elements and content interaction behaviors.

Input Parameters

string
required
The unique identifier of the user whose settings are to be updated.
boolean
If true, course navigation menus will load collapsed by default.
boolean
If true, the global navigation menu will load collapsed by default.
boolean
If true, user must manually mark discussion posts as read; false means posts are marked read automatically upon viewing.
boolean
If true, color overlays on dashboard course card images will be hidden.
boolean
If true, the badge indicating new release notes will be hidden.
boolean
If true, the classic Canvas dashboard view is displayed; false displays the Canvas for Elementary view.
boolean
If true, suggestions from the comment library will be displayed when commenting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the user whose text editor preference is to be updated. Use ‘self’ for the current authenticated user.
string ("block_editor" | "rce" | "")
required
The identifier for the editor. Valid values are ‘block_editor’ (Block Editor), ‘rce’ (Rich Content Editor), or empty string ” (no preference).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
The scopes to associate with the token. If omitted, the token’s current scopes will be preserved. Ignored if the default developer key does not have the ‘enable scopes’ option enabled.
string
The new purpose of the token. If omitted, the token’s current purpose will be preserved.
string
The ID of the user whose token will be updated. Use ‘self’ to update a token for the currently authenticated user, or provide a specific user ID.
string
required
The ID of the token to update, or the token_hint value.
string
The time at which the token will expire, in ISO 8601 format (e.g., ‘2024-12-31T23:59:59Z’). If omitted, the token’s current expiration date will be preserved.
boolean
If true, regenerates the actual token value while maintaining the same token ID. The old token will become invalid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The file to upload to the course.
string
required
Unique identifier of the accessible Canvas course.
string
Action for duplicate filenames: ‘overwrite’ or ‘rename’. If unspecified, Canvas’s default behavior applies.
integer
Unique ID of the target folder. If omitted, uploads to the course’s root folder. Mutually exclusive with parent_folder_path.
string
Full path to the target folder (e.g., ‘course_materials/week1’). If omitted, uploads to the course’s root folder. Mutually exclusive with parent_folder_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The filename of the file to upload. Any UTF-8 name is allowed (e.g., ‘test_document.txt’, ‘assignment.pdf’).
integer
The size of the file in bytes. Recommended to check quota before uploading.
string
required
The unique identifier of the group to upload the file to.
string
The MIME content type of the file (e.g., ‘text/plain’, ‘application/pdf’). If not provided, Canvas will attempt to guess from the file extension.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The file to upload for the submission.
string
required
Identifier of the user (e.g., student) making the submission; use ‘self’ for the currently authenticated user.
string
required
Identifier of the course containing the assignment.
string
required
Identifier of the assignment for the submission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The ID of an existing custom grade status to update. If not provided, a new custom grade status will be created.
string
required
The name of the custom grade status.
string
required
The hex color code for the status (e.g., #FF5733). Must start with # followed by 6 hexadecimal characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
ID of the standard grade status to update. If provided, updates an existing status; if omitted, creates a new one.
string
required
Name of the standard grade status. Must be one of the predefined Canvas status names: ‘late’, ‘missing’, ‘excused’, or ‘none’.
string
required
Color for the standard grade status in hex format (e.g., ‘#FF5733’). Must include the ’#’ prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANVAS_VALIDATE_QUIZ_ACCESS_CODEValidates a quiz access code by checking if it matches the configured access code for the quiz. Use when verifying student-provided access codes before allowing quiz access.

Input Parameters

string
required
The ID of the quiz to validate the access code for.
string
required
The ID of the course containing the quiz.
string
required
The access code to validate against the quiz’s configured access code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: CANVAS_ASSIGNMENT_GRADED_TRIGGERType: pollPolls Canvas for newly graded submissions for a specific assignment.

Configuration

integer
required
The ID of the assignment to monitor for grading activity.
integer
required
The ID of the Canvas course containing the assignment.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload

integer
required
The ID of the Canvas user who submitted the assignment.
string
The grade for the submission.
boolean
required
Whether the submission has been graded.
Slug: CANVAS_NEW_ASSIGNMENT_SUBMISSION_TRIGGERType: pollPolls Canvas for new submissions to a specific assignment.

Configuration

integer
required
The ID of the assignment to monitor for new submissions.
integer
required
The ID of the Canvas course containing the assignment.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload

integer
required
The ID of the Canvas user who submitted the assignment.
string
The grade, if graded.
integer
required
The ID of the submission.
boolean
required
Whether the submission was late.
string
required
URL to preview the submission.
string
The type of submission (online_text_entry, online_upload, etc).
string
When the submission was made.
string
required
The state of the submission (submitted, unsubmitted, graded, etc).
Slug: CANVAS_NEW_CANVAS_DISCUSSION_MESSAGE_TRIGGERType: pollPolls Canvas discussion topics for new messages.

Configuration

integer
required
The ID of the Canvas course containing the discussion.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The IDs of the discussion topics to monitor for new messages.

Payload

integer
Canvas user ID of the entry author.
integer
required
The course ID the discussion belongs to.
string
When the entry was created.
integer
required
The ID of the discussion entry.
string
The content of the discussion entry.
integer
Parent entry ID if this is a reply.
object
The raw API response for this entry.
integer
required
The discussion topic ID this entry belongs to.
string
When the entry was last updated.
string
The name of the user who posted the entry.
Slug: CANVAS_NEW_CANVAS_DISCUSSION_TRIGGERType: pollPolls a Canvas course for new discussion topics.

Configuration

integer
required
The ID of the Canvas course to monitor for new discussion topics.
string
The state of the discussion topics to return. Options: ‘all’, ‘unread’.
array
Additional fields to include. Options: ‘all_dates’, ‘sections’, ‘sections_user_count’, ‘overrides’
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
Determines the order of the discussion topic list. Options: ‘position’, ‘recent_activity’, ‘title’.

Payload

string
Type of discussion event
object
required
The discussion topic that was created
Slug: CANVAS_NEW_COURSE_CREATED_TRIGGERType: pollPolls Canvas for newly created courses for a specific user.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
required
The ID of the user to monitor courses for.

Payload

integer
The account ID the course belongs to.
string
The course code.
string
When the course was created.
string
When the course ends.
integer
The term ID for this course.
integer
required
The ID of the course.
string
required
The name of the course.
string
When the course starts.
string
The time zone of the course.
string
The state of the course.
Slug: CANVAS_NEW_FILE_UPLOADED_TRIGGERType: pollPolls a Canvas course for new file uploads.

Configuration

integer
required
The ID of the Canvas course to monitor for new file uploads.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload

array
required
The new files uploaded to Canvas.