> ## Documentation Index
> Fetch the complete documentation index at: https://docs.push.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Canvas

The Canvas API provides programmatic access to various learning
management features of the Canvas platform, including courses, users,
enrollments, grades, and more. It supports OAuth2 for secure
authentication and authorization.

> [accordion] Create Account Notification
>
> Creates a new global notification for an account in canvas.

> [accordion] Get Enrollment by ID
>
> Get an enrollment object by enrollment id

> [accordion] List Available Reports
>
> Lists available reports in canvas.

> [accordion] List Assignment Submissions
>
> Lists assignment submissions in canvas.

> [accordion] Create Page for a Course
>
> Creates a page for a course in canvas.

> [accordion] List Pages for a Course
>
> Lists pages for a course in canvas.

> [accordion] List Courses for a User
>
> Lists courses for a user in canvas. returns a paginated list of active courses for this user. to view the course list for a user other than yourself, you must be either an observer of that user or an administrator.

> [accordion] Create Appointment Group
>
> Creates an appointment group in canvas.

> [accordion] Get User Course Progress
>
> Returns progress information for a specific user in a course. the user can query their own progress using 'self' as the user id. to query another user's progress, the requester must be a teacher, administrator, or linked observer.

> [accordion] Export Content
>
> Exports content in a course in canvas.

> [accordion] List Sent Content Shares
>
> Lists sent content shares in canvas.

> [accordion] Retrieve Enrollment Term
>
> Retrieves an enrollment term in canvas. note: the specified account must be a root account, not a sub-account. for more details see: [https://canvas.instructure.com/doc/api/enrollment](https://canvas.instructure.com/doc/api/enrollment) terms.html

> [accordion] List Users in Account
>
> Lists users in an account in canvas.

> [accordion] Start a Report
>
> Starts a report in canvas.

> [accordion] Get Assignment
>
> Gets an assignment in canvas.

> [accordion] Get All Assignments
>
> Gets all assignments in a course in canvas.

> [accordion] List Quizzes in Course
>
> Lists quizzes in a canvas course.

> [accordion] Update File Name
>
> Updates the name of a file in canvas.

> [accordion] Translate File Reference
>
> Translates a file reference for a course in canvas.

> [accordion] List Submissions
>
> Lists submissions for a specific assignment, grader, and date in canvas.

> [accordion] Update Course Settings
>
> Updates course settings in canvas.

> [accordion] Get User Participation Analytics
>
> Returns page view hits grouped by hour and participation details for a student in a course. page views are returned as a hash with iso8601 dates as keys, bucketed by hour. participations are returned as an array of hashes, sorted oldest to newest.

> [accordion] List Calendar Events for a User
>
> Lists calendar events for a user in canvas.

> [accordion] Get Course Activity
>
> Gets activity analytics for a course in canvas.

> [accordion] Update Quiz Submission Scores
>
> Updates student question scores and comments for a quiz submission.

> [accordion] Update Appointment Group
>
> Updates an appointment group in canvas.

> [accordion] Create Assignment
>
> Creates an assignment in canvas.

> [accordion] Create Assignment Override
>
> Creates an assignment override in canvas.

> [accordion] Update Page for a Course
>
> Updates a page for a course in canvas.

> [accordion] List Communication Channels
>
> Lists communication channels for a user in canvas.

> [accordion] Upload Submission File
>
> Uploads a file to a submission in canvas.

> [accordion] Update User Settings
>
> Updates a user's settings in canvas.

> [accordion] Get User Profile
>
> Gets a user's profile in canvas.

> [accordion] Upload Course File
>
> Uploads a file to a canvas course.

> [accordion] Get Gradebook History Days
>
> Returns a list of day objects containing dates and graders who worked on those dates. each day object contains a date and an array of graders who worked on that date.

> [accordion] Update Course
>
> Update an existing course

> [accordion] List Communication Messages
>
> Lists communication messages for a user in canvas.

> [accordion] Get Current User
>
> Gets details of the current user in canvas.

> [accordion] Create Quiz
>
> Creates a quiz in canvas.

> [accordion] Get Page for a Course
>
> Gets a page for a course in canvas.

> [accordion] Create Calendar Event
>
> Create and return a new calendar event

> [accordion] List Submissions from Multiple Assignments
>
> Lists submissions for multiple assignments in canvas.

> [accordion] Get Completed Statistics
>
> Gets completed statistics for an account in canvas.

> [accordion] Grade or Comment on Submission
>
> Grades or comments on a submission in canvas.

> [accordion] Create Communication Channel
>
> Creates a communication channel for a user in canvas.

> [accordion] List Content Exports
>
> Lists content exports in a course in canvas.

> [accordion] Create Quiz Question
>
> Creates a quiz question in canvas.

> [accordion] Create Content Share
>
> Creates a content share in canvas. this action allows sharing content directly between two or more users. requires proper authentication and valid user ids.

> [accordion] List Uncollated Submission Versions
>
> Lists uncollated submission versions for a specific course in canvas.

> [accordion] Delete Appointment Group
>
> Deletes an appointment group in canvas.

> [accordion] Get Quiz Submissions
>
> Gets all quiz submissions for a quiz in canvas.

> [accordion] List Accounts for Course Admins
>
> Lists accounts for course admins in canvas.

> [accordion] List All Folders
>
> Lists all folders in a canvas course, user, or group context.

> [accordion] Delete Assignment
>
> Deletes an assignment in canvas.

> [accordion] Get Report Status
>
> Gets the status of a report in canvas.

> [accordion] List Appointment Groups
>
> Gets appointment groups in canvas.

> [accordion] Get Current Statistics
>
> Gets current statistics for an account in canvas.

> [accordion] List Course Users
>
> Returns the paginated list of users in a course, optionally including their enrollments.

> [accordion] Delete Quiz
>
> Deletes a quiz in canvas.

> [accordion] List Folders
>
> Lists all folders within the specified folder in canvas.

> [accordion] Create Conversation
>
> Creates a conversation in canvas.

> [accordion] Get Single Submission
>
> Gets a single submission in canvas.

> [accordion] Get a single Course
>
> Gets a single course in canvas.

> [accordion] Delete Folder
>
> Deletes a folder in canvas.

> [accordion] Get Current Grades
>
> Gets current grades for an account in canvas.

> [accordion] Get User Assignment Analytics
>
> Returns assignment analytics data for a specific student in a course. the data includes assignment details, grade statistics, and the student's submission information.

> [accordion] List Files
>
> Lists files for a course in canvas.

> [accordion] Get Term Grades
>
> Gets department level current data for term grades in canvas.

> [accordion] Get Completed Grades
>
> Gets grade distribution data for completed courses in an account in canvas. this action returns a dictionary containing the distribution of grades for students in completed courses. each data point represents one student's final grade in one course. the response contains grade scores (0-100) as keys and the number of students achieving that grade as values. grades are binned to the nearest integer score. required permissions: - account level analytics access - view all grades permission

> [accordion] Get Term Statistics
>
> Gets term statistics for an account in canvas.

> [accordion] List Courses
>
> Lists all courses in canvas.

> [accordion] List Discussion Topics
>
> Returns the paginated list of discussion topics for a course.

> [accordion] Create Enrollment
>
> Creates an enrollment in canvas for a user in a course.

> [accordion] Create Module
>
> Creates a module in canvas.

> [accordion] Edit Quiz
>
> Edits a quiz in canvas.

> [accordion] Create Folder
>
> Creates a folder in canvas within the specified context (course, user, group, folder, or account).

> [accordion] Edit Assignment
>
> Edits an assignment in canvas.

> [accordion] Create Discussion Topic
>
> Creates a new discussion topic for a course in canvas.

> [accordion] Create Course
>
> Creates a new course in canvas.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.