Skip to contents

Other methods.

Methods that need to be indexed.

create_course_datalake()
Create a data lake for a course.
canvas_authenticate()
Authenticate with Canvas LMS API
get_page_content()
Retrieves the content body of a specified page.
download_course_file()
Downloads a file from a given URL.
canvas_api_key()
Get the Canvas API key from the environment variable
canvas_base_url()
Get the Canvas base URL from the environment variable

Accounts

Methods for accounts.

get_accounts()
Get a list of accounts from the Canvas LMS API
list_all_enrollment_terms()
List All Enrollment Terms

Analytics

Methods for analytics.

get_department_participation_data()
Get department-level participation data from the Canvas LMS API
get_department_grade_data()
Get department-level grade data from the Canvas LMS API
get_department_statistics()
Get department-level statistics from the Canvas LMS API
get_department_statistics_by_subaccount()
Get department-level statistics by subaccount from the Canvas LMS API
get_course_participation()
Get course-level participation data from Canvas LMS API
get_student_summaries()
Get student summaries for a course from Canvas LMS API
get_user_course_participation_data()
Get user-in-a-course-level participation data from the Canvas LMS API
get_user_course_assignment_data()
Get user-in-a-course-level assignment data from the Canvas LMS API
get_user_course_messaging_data()
Get user-in-a-course-level messaging data from the Canvas LMS API

Announcements

Methods for announcements.

get_course_announcements()
Retrieves course announcements.

Assignment Groups

Methos for assignment groups.

get_assignment_groups()
Retrieves the assignment groups within a course.
create_assignment_group()
Create an Assignment Group in Canvas LMS

Assignments

Methods for assignments.

get_assignment_details()
Get Assignment Details from Canvas LMS API
get_assignment_data()
Get course-level assignment data from the Canvas LMS API
get_assignments()
Get Assignments from Canvas LMS API

Calendar Events

Calendat events methods.

get_calendar_events()
Get Calendar Events from Canvas LMS API

Content Migrations

Retrieve the list of content migrations.

upload_qti_file_with_migration()
Upload QTI File with Content Migration

Courses

Methods for courses.

get_course_details()
Get Course Details from Canvas LMS API
get_courses()
Get Courses from Canvas LMS API
get_course_students()
Retrieves the list of students in a course.
get_course_users()
Retrieves the users in a course.

Discussion Topics

Methods for discussion topics.

get_discussions()
Retrieves the discussion topics within a course.
post_new_discussion()
Post a New Discussion in Canvas LMS

Enrollments

Methods for enrollments.

get_course_enrollments()
Retrieves the course enrollments for a course.
get_section_students()
Retrieve Students in a Section

Favorites

Methods of favorites.

get_favorite_courses()
Get Favorite Courses in Canvas LMS

Files

Methods for files.

get_course_files()
Retrieves a list of files within a course.

Folders

Methods for folders.

get_course_folders()
Retrieves course folders.
create_folder()
Create a Folder in Canvas LMS

Group Categories

Methods for group categories.

create_group_category()
Create a Group Category in Canvas LMS
get_group_categories()
Get group categories for a context

Groups

Methods for groups.

get_group_info()
Get information about a single group
get_group_memberships()
Get group memberships
get_group_users()
Get users in a group
get_course_groups()
Retrieves the list of groups in a course.

Media Objects

Retrieve the list of Media Objects.

get_course_media_objects()
Retrieves the media objects in a course.

Modules

Methods for modules.

get_modules()
Retrieves the modules within a course.
create_module()
Create a Module in Canvas LMS

Module Items

Methods for module items.

get_module_items()
Retrieves the items within a specific module.
create_module_item()
Create a Module Item in Canvas LMS

Pages

Methods for pages.

get_course_pages()
Retrieves the pages within a course.
create_page()
Create a Page in Canvas LMS

Quizzes

Methods for quizzes.

get_course_quizzes()
Retrieves course quizzes.
update_quiz()
Modify an existing quiz.

Roles

Manage roles.

get_roles()
Retrieve Roles for a Canvas Account

Find recipients and list all courses.

get_all_courses()
Retrieves a paginated list of all courses visible in the public index.

Sections

Manage course sections.

get_course_sections()
Retrieves course sections.
create_course_section()
Create a Course Section in Canvas LMS
edit_section()
Edit a Course Section in Canvas LMS
delete_course_section()
Delete a Course Section in Canvas LMS
get_section_information()
Get Section Information in Canvas LMS

Submissions

Manage student submissions.

get_assignment_submissions()
Lists assignment submissions for a course.