Canvas

Creates a global notification within a canvas account, ensuring `end at` is after `start at` and any specified `notification roles` are valid.

Creates a new appointment group in canvas for schedulable time slots within specified course or group contexts.

Creates a new assignment within a specified course in canvas lms.

Creates 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.

Creates a calendar event with options for recurrence (finite `rrule` series only), section-specific timings, and blackout dates within a specified context.

Creates a new communication channel (e.g., email, sms, push) for an existing canvas user to receive notifications.

Shares a canvas content item to specified users, if the sender has necessary permissions and receiver ids are valid.

Use 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.

Creates a new course in canvas within a specified account, with comprehensive configuration options.

Creates a new discussion topic in a specified canvas course, allowing comprehensive configuration of its content, type, publication settings, engagement features, and associations.

Enrolls a user in a canvas course with a specified role and status; `associated user id` is required if `enrollment type` is 'observerenrollment'.

Creates a new folder in canvas within a specified context (e.g., course, user) and optional parent folder; ensure the context and any parent folder (specified by id or path, not both) already exist.

Creates a new organizational module within a specified canvas lms course, with options for availability, sequencing, and prerequisites.

Creates 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).

Creates a new quiz with various settings in a specified existing canvas course; `assignment group id` applies only to graded quiz types.

Creates 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.

Permanently deletes an existing appointment group by its id; associated appointments may also be canceled or affected.

Soft-deletes a specific assignment within a course, returning the assignment object with its `workflow state` updated to 'deleted'.

Permanently deletes an existing folder specified by its unique id.

Permanently deletes the quiz identified by `quiz id` from the course identified by `course id`; this action cannot be undone.

Fetches current, aggregated grade data from canvas analytics for a specified account id.

Retrieves department-level aggregated grade data for a specific academic term within a canvas account.

Updates an existing assignment in a canvas course (identified by `course id` and `assignment id`); only attributes explicitly provided in the request are modified.

Modifies an existing canvas quiz; only attributes with provided values in the request are updated.

Use to initiate an asynchronous export of content (e.g., common cartridge, qti, zip) from an existing canvas course, returning an export id and progress url.

Fetches a specific category of canvas data (e.g., accounts, courses, users) by setting exactly one `get *` boolean flag to true and providing any associated ids.

Retrieves all canvas accounts accessible to the authenticated user.

Retrieves assignments for a specified canvas course.

Retrieves a list of users for a specified canvas `account id` (use 'self' for the current user's root account), supporting filtering, sorting, and pagination.

Retrieves detailed information for a specific assignment within a given course in canvas.

Fetches the detailed rubric for a specified assignment within a canvas course; fails if the assignment has no associated rubric.

Retrieves daily activity analytics, such as page views and participation events, for a specified canvas course.

Retrieves detailed information about the currently authenticated user from the canvas lms.

Retrieves numeric statistics for all completed courses for a specified canvas account id; the account must exist.

Fetches a snapshot of current numerical statistics for a canvas account, requiring its valid id.

Retrieves the distribution of final grades (0-100, binned to whole numbers) for all completed courses in a canvas account, where each data point represents one student's final grade in one course.

Retrieves department-level academic term statistics (e.g., enrollment, activity, grades) for a specified account and term in canvas, provided analytics data is available.

Retrieves a specific enrollment by its id within a given account.

Retrieves a chronological list of dates with grading activity and the active graders for a specified course.

Retrieves a specific content page (wiki or content page) by its url or numeric id from a specified canvas course.

Retrieves all submissions for a specific quiz within a course; ensure `course id` and `quiz id` are valid and the quiz belongs to the course.

Retrieves the status of a previously initiated report in a canvas account, specified by its type and id.

Retrieves 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.

Retrieves a specific submission for an assignment made by a particular user within a designated course.

Retrieves files from a student's canvas assignment submission, processing text, binary, and zip files, and providing s3 download urls if s3 integration is active and uploads are successful.

Fetches detailed assignment-level analytics for a specific student in a designated course, including submission details and class performance statistics.

Retrieves the academic progress of a specific user within a given course.

Retrieves page view activity and participation details for a specific student enrolled in a designated course.

Retrieves profile information for an existing canvas user.

Updates 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.

Retrieves canvas accounts visible to the current user due to their course-level administrative roles; no request parameters are needed.

Retrieves the first page of folders for a specified canvas course id; this action is scoped to courses only.

Retrieves a list of canvas appointment groups based on specified filters; any provided `context codes` must be valid and accessible by the user.

Retrieves submissions for a specific assignment within a course, optionally including related resources or grouping by student group for group assignments.

Lists available reports (including those that can be or have been generated) for a valid canvas account id.

Retrieves calendar events and assignments for a specific user from canvas lms, supporting extensive filtering options detailed in the request schema.

Retrieves a list of communication channels associated with a specific user in canvas.

Retrieves communication messages from canvas.

Retrieves a paginated list of content exports from canvas for a specified, existing course.

Retrieves a list of the current user's courses from canvas, optionally filtered by enrollment type and state.

Retrieves a list of courses in canvas for a specified `user id`, requiring observer or admin permissions to view courses for others.

Retrieves 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.

Retrieves a paginated list of discussion topics or announcements for a specified course.

Fetches metadata (id, name, size, type, urls) for all files within a specified canvas course.

Retrieves a list of immediate sub-folders within the specified `folder id`.

Retrieves a list of wiki pages associated with a specific, existing course in canvas.

Retrieves a paginated list of quizzes for a specified, valid canvas course, optionally filtering by a search term in the quiz title.

Retrieves content shares sent by the specified user to other users or courses within canvas.

Fetches gradebook history submissions for a specific course, assignment, grader, and date from canvas.

Retrieves submissions from a canvas course for specified assignments and/or students; the course must be accessible.

Retrieves 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.

Use this action to retrieve all users associated with a specific, existing canvas account id.

Retrieves detailed information for a specific enrollment term within a given root account in canvas.

Initiates 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.

Resolves a file's migration id to its current representation within a specific canvas course.

Updates 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.

Updates an existing course, specified by its id, with new attributes or triggers a lifecycle event like 'conclude' or 'delete'.

Updates various settings for an existing course in canvas, identified by `course id`.

Modifies 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.

Updates an existing wiki page in a canvas course; if setting as front page, it must also be or be made published.

Updates 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.

Updates a canvas user's preferences for various interface elements and content interaction behaviors.

Uploads 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.

Uploads a submission file for an assignment in a canvas course for a specified `user id`; this user must be enrolled, the assignment open for them, and 'masquerade' permissions may be needed if `user id` isn't 'self'.