Canvas LMS REST API

The Canvas LMS REST API provides programmatic access to courses, assignments, quizzes, grades, users, enrollments, accounts, discussions, files, modules, rubrics, submissions, SIS imports, and account administration. It uses OAuth 2.0 access tokens and returns JSON with ISO 8601 timestamps, supporting pagination, request throttling, masquerading, and compound documents.

Documentation Provider Profile APIs.io OpenAPI GitHub

Canvas LMS REST API is one of 4 APIs that Canvas publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Education, LMS, and REST. The published artifact set on APIs.io includes API documentation, authentication docs, a GitHub repository, an OpenAPI specification, an API reference, and rate-limit docs.

This API exposes 1117 operations across 789 paths, organized into 143 resource areas, and defines 283 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against 2 base URLs: https://canvas.instructure.com/api, https://{canvas_host}/api.

1117 operations 789 paths 283 schemas 125 DELETE562 GET6 PATCH236 POST188 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

Base URL

https://canvas.instructure.com/api/v1

Authentication

HTTP Bearer, OAuth 2.0

Contact

Instructure Canvas

License

AGPL-3.0

Resource Areas

143

Authentication & Security 2

Canvas LMS REST API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow. By default, every request must be authenticated.

bearerAuth — Canvas OAuth2 access token sent as "Authorization: Bearer ". See https://canvas.instructure.com/doc/api/file.oauth.html
oauth2 — Canvas OAuth2. See https://canvas.instructure.com/doc/api/file.oauth.html and https://canvas.instructure.com/doc/api/file.oauthendpoints.html

Paths & Operations 1117

Across 789 paths, the API surfaces 1117 operations — 125 DELETE, 562 GET, 6 PATCH, 236 POST, 188 PUT. They span 143 resource areas, including Access Tokens, Accessibility Course Scans, Accessibility Course Statistics, Account Calendars, Account Domain Lookups, Account Notifications, Account Reports, Accounts, and 135 more. Each is listed below with its method, path, parameters, and response codes.

Access Tokens 5

GET

/v1/users/{user_id}/user_generated_tokens

List access tokens for a user

list_access_tokens_for_user 2 params → 200

GET

/v1/users/{user_id}/tokens/{id}

Show an access token

show_access_token 2 params → 200

PUT

/v1/users/{user_id}/tokens/{id}

Update an access token

update_access_token 2 params body → 200

DELETE

/v1/users/{user_id}/tokens/{id}

Delete an access token

delete_access_token 2 params → 200

POST

/v1/users/{user_id}/tokens

Create an access token

create_access_token 1 param body → 200

Accessibility Course Scans 1

POST

/v1/users/{user_id}/educator_accessibility_course_scan

Trigger accessibility course scan

trigger_accessibility_course_scan 1 param → 200

Accessibility Course Statistics 2

GET

/v1/users/{user_id}/educator_accessibility_course_statistics

List accessibility course statistics

list_accessibility_course_statistics 2 params → 200

GET

/v1/users/{user_id}/educator_accessibility_course_terms

List accessibility course statistic terms

list_accessibility_course_statistic_terms 1 param → 200

Account Calendars 6

GET

/v1/account_calendars

List available account calendars

list_available_account_calendars 1 param → 200

GET

/v1/account_calendars/{account_id}

Get a single account calendar

get_single_account_calendar 1 param → 200

PUT

/v1/account_calendars/{account_id}

Update a calendar

update_calendar 1 param body → 200

PUT

/v1/accounts/{account_id}/account_calendars

Update several calendars

update_several_calendars 1 param → 200

GET

/v1/accounts/{account_id}/account_calendars

List all account calendars

list_all_account_calendars 3 params → 200

GET

/v1/accounts/{account_id}/visible_calendars_count

Count of all visible account calendars

count_of_all_visible_account_calendars 1 param → 200

Account Domain Lookups 1

GET

/v1/accounts/search

Search account domains

search_account_domains 4 params → 200

Account Notifications 5

GET

/v1/accounts/{account_id}/account_notifications

Index of active global notification for the user

index_of_active_global_notification_for_user 4 params → 200

POST

/v1/accounts/{account_id}/account_notifications

Create a global notification

create_global_notification 1 param body → 200

GET

/v1/accounts/{account_id}/account_notifications/{id}

Show a global notification

show_global_notification 2 params → 200

PUT

/v1/accounts/{account_id}/account_notifications/{id}

Update a global notification

update_global_notification 2 params body → 200

DELETE

/v1/accounts/{account_id}/account_notifications/{id}

Close notification for user. Destroy notification for admin

close_notification_for_user_destroy_notification_for_admin 3 params → 200

Account Reports 6

GET

/v1/accounts/{account_id}/reports

List Available Reports

list_available_reports 2 params → 200

POST

/v1/accounts/{account_id}/reports/{report}

Start a Report

start_report 2 params body → 200

GET

/v1/accounts/{account_id}/reports/{report}

Index of Reports

index_of_reports 2 params → 200

GET

/v1/accounts/{account_id}/reports/{report}/{id}

Status of a Report

status_of_report 3 params → 200

DELETE

/v1/accounts/{account_id}/reports/{report}/{id}

Delete a Report

delete_report 3 params → 200

PUT

/v1/accounts/{account_id}/reports/{report}/{id}/abort

Abort a Report

abort_report 3 params → 200

Accounts 21

GET

/v1/accounts

List accounts

list_accounts 1 param → 200

GET

/v1/horizon_accounts

List horizon accounts

list_horizon_accounts 1 param → 200

GET

/v1/manageable_accounts

Get accounts that admins can manage

get_accounts_that_admins_can_manage → 200

GET

/v1/course_creation_accounts

Get accounts that users can create courses in

get_accounts_that_users_can_create_courses_in → 200

GET

/v1/course_accounts

List accounts for course admins

list_accounts_for_course_admins → 200

GET

/v1/accounts/{id}

Get a single account

get_single_account 1 param → 200

PUT

/v1/accounts/{id}

Update an account

update_account 1 param body → 200

GET

/v1/accounts/{account_id}/settings

Settings

settings 1 param → 200

GET

/v1/settings/environment

List environment settings

list_environment_settings → 200

GET

/v1/accounts/{account_id}/permissions

Permissions

permissions 2 params → 200

GET

/v1/accounts/{account_id}/sub_accounts

Get the sub-accounts of an account

get_sub_accounts_of_account 4 params → 200

POST

/v1/accounts/{account_id}/sub_accounts

Create a new sub-account

create_new_sub_account 1 param body → 200

GET

/v1/accounts/{account_id}/terms_of_service

Get the Terms of Service

get_terms_of_service 1 param → 200

GET

/v1/accounts/{account_id}/help_links

Get help links

get_help_links 1 param → 200

GET

/v1/manually_created_courses_account

Get the manually-created courses sub-account for the domain root account

get_manually_created_courses_sub_account_for_domain_root_account → 200

GET

/v1/accounts/{account_id}/courses

List active courses in an account

list_active_courses_in_account 22 params → 200

DELETE

/v1/accounts/{account_id}/users/{user_id}

Delete a user from the root account

delete_user_from_root_account 2 params → 200

DELETE

/v1/accounts/{account_id}/users

Delete multiple users from the root account

delete_multiple_users_from_root_account 1 param → 200

PUT

/v1/accounts/{account_id}/users/bulk_update

Update multiple users

update_multiple_users 1 param body → 200

PUT

/v1/accounts/{account_id}/users/{user_id}/restore

Restore a deleted user from a root account

restore_deleted_user_from_root_account 2 params → 200

DELETE

/v1/accounts/{account_id}/sub_accounts/{id}

Delete a sub-account

delete_sub_account 2 params → 200

Courses 31

POST

/v1/accounts/{account_id}/courses

Create a new course

create_new_course 1 param body → 200

PUT

/v1/accounts/{account_id}/courses

Update courses

update_courses 1 param body → 200

GET

/v1/courses

List your courses

list_your_courses 7 params → 200

GET

/v1/users/{user_id}/courses

List courses for a user

list_courses_for_user 6 params → 200

GET

/v1/courses/{course_id}/users/{user_id}/progress

Get user progress

get_user_progress 2 params → 200

POST

/v1/courses/{course_id}/files

Upload a file

upload_file 1 param → 200

GET

/v1/courses/{course_id}/students

List students

list_students 1 param → 200

GET

/v1/courses/{course_id}/users

List users in course

list_users_in_course_users 11 params → 200

GET

/v1/courses/{course_id}/search_users

List users in course

list_users_in_course_search_users 11 params → 200

GET

/v1/courses/{course_id}/recent_students

List recently logged in students

list_recently_logged_in_students 1 param → 200

GET

/v1/courses/{course_id}/users/{id}

Get single user

get_single_user 2 params → 200

GET

/v1/courses/{course_id}/content_share_users

Search for content share users

search_for_content_share_users 2 params → 200

POST

/v1/courses/{course_id}/preview_html

Preview processed html

preview_processed_html 1 param body → 200

GET

/v1/courses/{course_id}/activity_stream

Course activity stream

course_activity_stream 1 param → 200

GET

/v1/courses/{course_id}/activity_stream/summary

Course activity stream summary

course_activity_stream_summary 1 param → 200

GET

/v1/courses/{course_id}/todo

Course TODO items

course_todo_items 1 param → 200

DELETE

/v1/courses/{id}

Delete/Conclude a course

delete_conclude_course 2 params → 200

GET

/v1/courses/{id}

Get a single course

get_single_course_courses 3 params → 200

PUT

/v1/courses/{id}

Update a course

update_course 1 param body → 200

GET

/v1/courses/{course_id}/settings

Get course settings

get_course_settings 1 param → 200

PUT

/v1/courses/{course_id}/settings

Update course settings

update_course_settings 1 param body → 200

GET

/v1/courses/{course_id}/student_view_student

Return test student for course

return_test_student_for_course 1 param → 200

GET

/v1/accounts/{account_id}/courses/{id}

Get a single course

get_single_course_accounts 4 params → 200

POST

/v1/courses/{course_id}/reset_content

Reset a course

reset_course 1 param → 200

GET

/v1/courses/{course_id}/effective_due_dates

Get effective due dates

get_effective_due_dates 2 params → 200

GET

/v1/courses/{course_id}/permissions

Permissions

permissions_courses 2 params → 200

GET

/v1/courses/{course_id}/bulk_user_progress

Get bulk user progress

get_bulk_user_progress 1 param → 200

POST

/v1/courses/{id}/dismiss_migration_limitation_message

Remove quiz migration alert

remove_quiz_migration_alert 1 param → 200

POST

/v1/courses/{course_id}/restore/{version_id}

Restore course syllabus version

restore_course_syllabus_version 2 params → 200

GET

/v1/courses/{course_id}/course_copy/{id}

Get course copy status

get_course_copy_status 2 params → 200

POST

/v1/courses/{course_id}/course_copy

Copy course content

copy_course_content 1 param body → 200

Users 48

GET

/v1/accounts/{account_id}/users

List users in account

list_users_in_account 7 params → 200

POST

/v1/accounts/{account_id}/users

Create a user

create_user 1 param body → 200

POST

/v1/users/{user_id}/files

Upload a file

upload_file_users 1 param → 200

GET

/v1/users/self/activity_stream

List the activity stream

list_activity_stream_self 1 param → 200

DELETE

/v1/users/self/activity_stream

Hide all stream items

hide_all_stream_items → 200

GET

/v1/users/activity_stream

List the activity stream

list_activity_stream_activity_stream 1 param → 200

GET

/v1/users/self/activity_stream/summary

Activity stream summary

activity_stream_summary 1 param → 200

GET

/v1/users/self/todo

List the TODO items

list_todo_items 3 params → 200

GET

/v1/users/self/todo_item_count

List counts for todo items

list_counts_for_todo_items 1 param → 200

GET

/v1/users/self/upcoming_events

List upcoming assignments, calendar events

list_upcoming_assignments_calendar_events → 200

GET

/v1/users/{user_id}/missing_submissions

List Missing Submissions

list_missing_submissions 5 params → 200

DELETE

/v1/users/self/activity_stream/{id}

Hide a stream item

hide_stream_item 1 param → 200

GET

/v1/users/{id}

Show user details

show_user_details 2 params → 200

PUT

/v1/users/{id}

Edit a user

edit_user 1 param body → 200

POST

/v1/accounts/{account_id}/self_registration

[DEPRECATED] Self register a user

deprecated_self_register_user 1 param body → 200

GET

/v1/users/{id}/settings

Update user settings.

update_user_settings 10 params → 200

GET

/v1/users/{id}/colors

Get custom colors

get_custom_colors 1 param → 200

GET

/v1/users/{id}/colors/{asset_string}

Get custom color

get_custom_color 2 params → 200

PUT

/v1/users/{id}/colors/{asset_string}

Update custom color

update_custom_color 2 params body → 200

PUT

/v1/users/{id}/text_editor_preference

Update text editor preference

update_text_editor_preference 1 param body → 200

PUT

/v1/users/{id}/files_ui_version_preference

Update files UI version preference

update_files_ui_version_preference 1 param body → 200

GET

/v1/users/{id}/dashboard_positions

Get dashboard positions

get_dashboard_positions 1 param → 200

PUT

/v1/users/{id}/dashboard_positions

Update dashboard positions

update_dashboard_positions 1 param → 200

DELETE

/v1/users/{id}/sessions

Terminate all user sessions

terminate_all_user_sessions 1 param → 200

DELETE

/v1/users/mobile_sessions

Log users out of all mobile apps

log_users_out_of_all_mobile_apps_mobile_sessions 1 param → 200

DELETE

/v1/users/{id}/mobile_sessions

Log users out of all mobile apps

log_users_out_of_all_mobile_apps_id 2 params → 200

PUT

/v1/users/{id}/merge_into/{destination_user_id}

Merge user into another user

merge_user_into_another_user_destination_user_id 2 params → 200

PUT

/v1/users/{id}/merge_into/accounts/{destination_account_id}/users/{destination_user_id}

Merge user into another user

merge_user_into_another_user_accounts 3 params → 200

POST

/v1/users/{id}/split

Split merged users into separate users

split_merged_users_into_separate_users 1 param → 200

POST

/v1/users/self/pandata_events_token

Get a Pandata Events jwt token and its expiration date

get_pandata_events_jwt_token_and_its_expiration_date body → 200

GET

/v1/users/{id}/graded_submissions

Get a users most recently graded submissions

get_users_most_recently_graded_submissions 4 params → 200

GET

/v1/users/{user_id}/profile

Get user profile

get_user_profile 2 params → 200

GET

/v1/users/{user_id}/avatars

List avatar options

list_avatar_options 1 param → 200

GET

/v1/users/{user_id}/page_views

List user page views

list_user_page_views 3 params → 200

POST

/v1/users/{user_id}/page_views/query

BETA - Initiate page views query

beta_initiate_page_views_query 1 param body → 200

GET

/v1/users/{user_id}/page_views/query/{query_id}

BETA - Poll query status

beta_poll_query_status 2 params → 200

GET

/v1/users/{user_id}/page_views/query/{query_id}/results

BETA - Get query results

beta_get_query_results 2 params → 200

POST

/v1/users/page_views/query

BETA - Initiate batch page views query

beta_initiate_batch_page_views_query body → 200

GET

/v1/users/page_views/query/{query_id}

BETA - Poll batch query status

beta_poll_batch_query_status 1 param → 200

GET

/v1/users/page_views/query/{query_id}/results

BETA - Get batch query results

beta_get_batch_query_results 1 param → 200

PUT

/v1/users/{user_id}/custom_data

Store custom data

store_custom_data 1 param body → 200

GET

/v1/users/{user_id}/custom_data

Load custom data

load_custom_data 2 params → 200

DELETE

/v1/users/{user_id}/custom_data

Delete custom data

delete_custom_data 2 params → 200

GET

/v1/users/self/course_nicknames

List course nicknames

list_course_nicknames → 200

DELETE

/v1/users/self/course_nicknames

Clear course nicknames

clear_course_nicknames → 200

GET

/v1/users/self/course_nicknames/{course_id}

Get course nickname

get_course_nickname 1 param → 200

PUT

/v1/users/self/course_nicknames/{course_id}

Set course nickname

set_course_nickname 1 param body → 200

DELETE

/v1/users/self/course_nicknames/{course_id}

Remove course nickname

remove_course_nickname 1 param → 200

Accounts (Lti) 1

GET

/lti/accounts/{account_id}

Get account

get_account 1 param → 200

Admins 4

GET

/v1/accounts/{account_id}/admins

List account admins

list_account_admins 4 params → 200

POST

/v1/accounts/{account_id}/admins

Make an account admin

make_account_admin 1 param body → 200

DELETE

/v1/accounts/{account_id}/admins/{user_id}

Remove account admin

remove_account_admin 4 params → 200

GET

/v1/accounts/{account_id}/admins/self

List my admin roles

list_my_admin_roles 1 param → 200

Ai Conversations 9

GET

/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}

Show conversation

show_conversation 3 params → 200

DELETE

/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}

Delete AI conversation

delete_ai_conversation 3 params → 200

GET

/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations

Get active conversation

get_active_conversation 2 params → 200

POST

/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations

Create AI conversation

create_ai_conversation 2 params → 200

POST

/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/messages

Post message to conversation

post_message_to_conversation 3 params body → 200

GET

/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/evaluation

Get conversation evaluation

get_conversation_evaluation 3 params → 200

POST

/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/evaluation

Generate conversation evaluation

generate_conversation_evaluation 3 params → 200

POST

/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/messages/{message_id}/feedback

Create feedback on a conversation message

create_feedback_on_conversation_message 4 params body → 200

DELETE

/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/messages/{message_id}/feedback/{feedback_id}

Delete feedback on a conversation message

delete_feedback_on_conversation_message 5 params → 200

Ai Experiences 9

GET

/v1/courses/{course_id}/ai_experiences

List AI experiences

list_ai_experiences 2 params → 200

POST

/v1/courses/{course_id}/ai_experiences

Create an AI experience

create_ai_experience 1 param body → 200

GET

/v1/courses/{course_id}/ai_experiences/{id}

Show an AI experience

show_ai_experience 2 params → 200

PUT

/v1/courses/{course_id}/ai_experiences/{id}

Update an AI experience

update_ai_experience 2 params body → 200

DELETE

/v1/courses/{course_id}/ai_experiences/{id}

Delete an AI experience

delete_ai_experience 2 params → 200

GET

/v1/courses/{course_id}/ai_experiences/new

Show new AI experience form

show_new_ai_experience_form 1 param → 200

GET

/v1/courses/{course_id}/ai_experiences/{id}/edit

Show edit AI experience form

show_edit_ai_experience_form 2 params → 200

GET

/v1/courses/{course_id}/ai_experiences/{id}/ai_conversations

List student AI conversations

list_student_ai_conversations 2 params → 200

GET

/v1/courses/{course_id}/ai_experiences/{id}/ai_conversations/{conversation_id}

Show student AI conversation

show_student_ai_conversation 3 params → 200

Analytics 18

GET

/v1/accounts/{account_id}/analytics/terms/{term_id}/activity

Get department-level participation data

get_department_level_participation_data_terms 2 params → 200

GET

/v1/accounts/{account_id}/analytics/current/activity

Get department-level participation data

get_department_level_participation_data_current 1 param → 200

GET

/v1/accounts/{account_id}/analytics/completed/activity

Get department-level participation data

get_department_level_participation_data_completed 1 param → 200

GET

/v1/accounts/{account_id}/analytics/terms/{term_id}/grades

Get department-level grade data

get_department_level_grade_data_terms 2 params → 200

GET

/v1/accounts/{account_id}/analytics/current/grades

Get department-level grade data

get_department_level_grade_data_current 1 param → 200

GET

/v1/accounts/{account_id}/analytics/completed/grades

Get department-level grade data

get_department_level_grade_data_completed 1 param → 200

GET

/v1/accounts/{account_id}/analytics/terms/{term_id}/statistics

Get department-level statistics

get_department_level_statistics_terms 2 params → 200

GET

/v1/accounts/{account_id}/analytics/current/statistics

Get department-level statistics

get_department_level_statistics_current 1 param → 200

GET

/v1/accounts/{account_id}/analytics/completed/statistics

Get department-level statistics

get_department_level_statistics_completed 1 param → 200

GET

/v1/accounts/{account_id}/analytics/terms/{term_id}/statistics_by_subaccount

Get department-level statistics, broken down by subaccount

get_department_level_statistics_broken_down_by_subaccount_terms 2 params → 200

GET

/v1/accounts/{account_id}/analytics/current/statistics_by_subaccount

Get department-level statistics, broken down by subaccount

get_department_level_statistics_broken_down_by_subaccount_current 1 param → 200

GET

/v1/accounts/{account_id}/analytics/completed/statistics_by_subaccount

Get department-level statistics, broken down by subaccount

get_department_level_statistics_broken_down_by_subaccount_completed 1 param → 200

GET

/v1/courses/{course_id}/analytics/activity

Get course-level participation data

get_course_level_participation_data 1 param → 200

GET

/v1/courses/{course_id}/analytics/assignments

Get course-level assignment data

get_course_level_assignment_data 2 params → 200

GET

/v1/courses/{course_id}/analytics/student_summaries

Get course-level student summary data

get_course_level_student_summary_data 3 params → 200

GET

/v1/courses/{course_id}/analytics/users/{student_id}/activity

Get user-in-a-course-level participation data

get_user_in_a_course_level_participation_data 2 params → 200

GET

/v1/courses/{course_id}/analytics/users/{student_id}/assignments

Get user-in-a-course-level assignment data

get_user_in_a_course_level_assignment_data 2 params → 200

GET

/v1/courses/{course_id}/analytics/users/{student_id}/communication

Get user-in-a-course-level messaging data

get_user_in_a_course_level_messaging_data 2 params → 200

Announcement External Feeds 6

GET

/v1/courses/{course_id}/external_feeds

List external feeds

list_external_feeds_courses 1 param → 200

POST

/v1/courses/{course_id}/external_feeds

Create an external feed

create_external_feed_courses 1 param body → 200

GET

/v1/groups/{group_id}/external_feeds

List external feeds

list_external_feeds_groups 1 param → 200

POST

/v1/groups/{group_id}/external_feeds

Create an external feed

create_external_feed_groups 1 param body → 200

DELETE

/v1/courses/{course_id}/external_feeds/{external_feed_id}

Delete an external feed

delete_external_feed_courses 2 params → 200

DELETE

/v1/groups/{group_id}/external_feeds/{external_feed_id}

Delete an external feed

delete_external_feed_groups 2 params → 200

Announcements 1

GET

/v1/announcements

List announcements

list_announcements 7 params → 200

Api Token Scopes 1

GET

/v1/accounts/{account_id}/scopes

List scopes

list_scopes 2 params → 200

Appointment Groups 8

GET

/v1/appointment_groups

List appointment groups

list_appointment_groups 4 params → 200

POST

/v1/appointment_groups

Create an appointment group

create_appointment_group body → 200

GET

/v1/appointment_groups/{id}

Get a single appointment group

get_single_appointment_group 2 params → 200

PUT

/v1/appointment_groups/{id}

Update an appointment group

update_appointment_group 1 param body → 200

DELETE

/v1/appointment_groups/{id}

Delete an appointment group

delete_appointment_group 2 params → 200

GET

/v1/appointment_groups/{id}/users

List user participants

list_user_participants 2 params → 200

GET

/v1/appointment_groups/{id}/groups

List student group participants

list_student_group_participants 2 params → 200

GET

/v1/appointment_groups/next_appointment

Get next appointment

get_next_appointment 1 param → 200

Assessment Question Banks 3

GET

/v1/question_banks

List question banks

list_question_banks 3 params → 200

GET

/v1/question_banks/{id}

Get a single question bank

get_single_question_bank 2 params → 200

GET

/v1/question_banks/{id}/questions

List assessment questions for a question bank

list_assessment_questions_for_question_bank 1 param → 200

Asset Processor 4

POST

/lti/asset_processors/{asset_processor_id}/reports

Create an Asset Report

create_asset_report 1 param body → 200

PUT

/lti/asset_processor_eulas/{context_external_tool_id}/deployment

Update Eula Deployment Configuration

update_eula_deployment_configuration 1 param body → 200

POST

/lti/asset_processor_eulas/{context_external_tool_id}/user

Create an Eula Acceptance

create_eula_acceptance 1 param body → 200

DELETE

/lti/asset_processor_eulas/{context_external_tool_id}/user

Delete Eula Acceptances for deployment

delete_eula_acceptances_for_deployment 1 param → 200

Assignment Extensions 1

POST

/v1/courses/{course_id}/assignments/{assignment_id}/extensions

Set extensions for student assignment submissions

set_extensions_for_student_assignment_submissions 2 params body → 200

Assignment Groups 5

GET

/v1/courses/{course_id}/assignment_groups

List assignment groups

list_assignment_groups 7 params → 200

POST

/v1/courses/{course_id}/assignment_groups

Create an Assignment Group

create_assignment_group 1 param body → 200

GET

/v1/courses/{course_id}/assignment_groups/{assignment_group_id}

Get an Assignment Group

get_assignment_group 5 params → 200

PUT

/v1/courses/{course_id}/assignment_groups/{assignment_group_id}

Edit an Assignment Group

edit_assignment_group 2 params body → 200

DELETE

/v1/courses/{course_id}/assignment_groups/{assignment_group_id}

Destroy an Assignment Group

destroy_assignment_group 3 params → 200

Assignments 20

DELETE

/v1/courses/{course_id}/assignments/{id}

Delete an assignment

delete_assignment 2 params → 200

GET

/v1/courses/{course_id}/assignments/{id}

Get a single assignment

get_single_assignment 6 params → 200

PUT

/v1/courses/{course_id}/assignments/{id}

Edit an assignment

edit_assignment 2 params body → 200

GET

/v1/courses/{course_id}/assignments

List assignments

list_assignments_assignments 10 params → 200

POST

/v1/courses/{course_id}/assignments

Create an assignment

create_assignment 1 param body → 200

GET

/v1/courses/{course_id}/assignment_groups/{assignment_group_id}/assignments

List assignments

list_assignments_assignment_groups 11 params → 200

GET

/v1/users/{user_id}/courses/{course_id}/assignments

List assignments for user

list_assignments_for_user 2 params → 200

POST

/v1/courses/{course_id}/assignments/{assignment_id}/duplicate

Duplicate assignment

duplicate_assignment 2 params body → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/users/{user_id}/group_members

List group members for a student on an assignment

list_group_members_for_student_on_assignment 3 params → 200

PUT

/v1/courses/{course_id}/assignments/bulk_update

Bulk update assignment dates

bulk_update_assignment_dates 1 param → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/overrides

List assignment overrides

list_assignment_overrides 2 params → 200

POST

/v1/courses/{course_id}/assignments/{assignment_id}/overrides

Create an assignment override

create_assignment_override 2 params body → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/overrides/{id}

Get a single assignment override

get_single_assignment_override 3 params → 200

PUT

/v1/courses/{course_id}/assignments/{assignment_id}/overrides/{id}

Update an assignment override

update_assignment_override 3 params body → 200

DELETE

/v1/courses/{course_id}/assignments/{assignment_id}/overrides/{id}

Delete an assignment override

delete_assignment_override 3 params → 200

GET

/v1/groups/{group_id}/assignments/{assignment_id}/override

Redirect to the assignment override for a group

redirect_to_assignment_override_for_group 2 params → 200

GET

/v1/sections/{course_section_id}/assignments/{assignment_id}/override

Redirect to the assignment override for a section

redirect_to_assignment_override_for_section 2 params → 200

GET

/v1/courses/{course_id}/assignments/overrides

Batch retrieve overrides in a course

batch_retrieve_overrides_in_course 3 params → 200

POST

/v1/courses/{course_id}/assignments/overrides

Batch create overrides in a course

batch_create_overrides_in_course 1 param body → 200

PUT

/v1/courses/{course_id}/assignments/overrides

Batch update overrides in a course

batch_update_overrides_in_course 1 param body → 200

Authentication Providers 9

GET

/v1/accounts/{account_id}/authentication_providers

List authentication providers

list_authentication_providers 1 param → 200

POST

/v1/accounts/{account_id}/authentication_providers

Add authentication provider

add_authentication_provider 1 param → 200

GET

/v1/accounts/{account_id}/authentication_providers/{id}

Get authentication provider

get_authentication_provider 2 params → 200

PUT

/v1/accounts/{account_id}/authentication_providers/{id}

Update authentication provider

update_authentication_provider 2 params → 200

DELETE

/v1/accounts/{account_id}/authentication_providers/{id}

Delete authentication provider

delete_authentication_provider 2 params → 200

PUT

/v1/accounts/{account_id}/authentication_providers/{id}/restore

Restore a deleted authentication provider

restore_deleted_authentication_provider 2 params → 200

GET

/v1/accounts/{account_id}/sso_settings

Show account auth settings

show_account_auth_settings 1 param → 200

PUT

/v1/accounts/{account_id}/sso_settings

Update account auth settings

update_account_auth_settings 1 param → 200

POST

/v1/accounts/{account_id}/authentication_providers/force_password_reset

Force password reset

force_password_reset 1 param → 200

Authentications Log 3

GET

/v1/audit/authentication/logins/{login_id}

Query by login.

query_by_login 3 params → 200

GET

/v1/audit/authentication/accounts/{account_id}

Query by account.

query_by_account 5 params → 200

GET

/v1/audit/authentication/users/{user_id}

Query by user.

query_by_user 3 params → 200

Blackout Dates 13

GET

/v1/courses/{course_id}/blackout_dates

List blackout dates

list_blackout_dates_courses 1 param → 200

POST

/v1/courses/{course_id}/blackout_dates

Create Blackout Date

create_blackout_date_courses 1 param body → 200

PUT

/v1/courses/{course_id}/blackout_dates

Update a list of Blackout Dates

update_list_of_blackout_dates 1 param body → 200

GET

/v1/accounts/{account_id}/blackout_dates

List blackout dates

list_blackout_dates_accounts 1 param → 200

POST

/v1/accounts/{account_id}/blackout_dates

Create Blackout Date

create_blackout_date_accounts 1 param body → 200

GET

/v1/courses/{course_id}/blackout_dates/{id}

Get a single blackout date

get_single_blackout_date_courses 2 params → 200

PUT

/v1/courses/{course_id}/blackout_dates/{id}

Update Blackout Date

update_blackout_date_courses 2 params body → 200

DELETE

/v1/courses/{course_id}/blackout_dates/{id}

Delete Blackout Date

delete_blackout_date_courses 2 params → 200

GET

/v1/accounts/{account_id}/blackout_dates/{id}

Get a single blackout date

get_single_blackout_date_accounts 2 params → 200

PUT

/v1/accounts/{account_id}/blackout_dates/{id}

Update Blackout Date

update_blackout_date_accounts 2 params body → 200

DELETE

/v1/accounts/{account_id}/blackout_dates/{id}

Delete Blackout Date

delete_blackout_date_accounts 2 params → 200

GET

/v1/courses/{course_id}/blackout_dates/new

New Blackout Date

new_blackout_date_courses 1 param → 200

GET

/v1/accounts/{account_id}/blackout_dates/new

New Blackout Date

new_blackout_date_accounts 1 param → 200

Block Editor Template 1

GET

/v1/courses/{course_id}/block_editor_templates

List block templates

list_block_templates 6 params → 200

Blueprint Courses 13

GET

/v1/courses/{course_id}/blueprint_templates/{template_id}

Get blueprint information

get_blueprint_information 2 params → 200

GET

/v1/courses/{course_id}/blueprint_templates/{template_id}/associated_courses

Get associated course information

get_associated_course_information 2 params → 200

PUT

/v1/courses/{course_id}/blueprint_templates/{template_id}/update_associations

Update associated courses

update_associated_courses 2 params body → 200

POST

/v1/courses/{course_id}/blueprint_templates/{template_id}/migrations

Begin a migration to push to associated courses

begin_migration_to_push_to_associated_courses 2 params body → 200

GET

/v1/courses/{course_id}/blueprint_templates/{template_id}/migrations

List blueprint migrations

list_blueprint_migrations 2 params → 200

PUT

/v1/courses/{course_id}/blueprint_templates/{template_id}/restrict_item

Set or remove restrictions on a blueprint course object

set_or_remove_restrictions_on_blueprint_course_object 2 params body → 200

GET

/v1/courses/{course_id}/blueprint_templates/{template_id}/unsynced_changes

Get unsynced changes

get_unsynced_changes 2 params → 200

GET

/v1/courses/{course_id}/blueprint_templates/{template_id}/migrations/{id}

Show a blueprint migration

show_blueprint_migration 3 params → 200

GET

/v1/courses/{course_id}/blueprint_templates/{template_id}/migrations/{id}/details

Get migration details

get_migration_details 3 params → 200

GET

/v1/courses/{course_id}/blueprint_subscriptions

List blueprint subscriptions

list_blueprint_subscriptions 1 param → 200

GET

/v1/courses/{course_id}/blueprint_subscriptions/{subscription_id}/migrations

List blueprint imports

list_blueprint_imports 2 params → 200

GET

/v1/courses/{course_id}/blueprint_subscriptions/{subscription_id}/migrations/{id}

Show a blueprint import

show_blueprint_import 3 params → 200

GET

/v1/courses/{course_id}/blueprint_subscriptions/{subscription_id}/migrations/{id}/details

Get import details

get_import_details 3 params → 200

Bookmarks 5

GET

/v1/users/self/bookmarks

List bookmarks

list_bookmarks → 200

POST

/v1/users/self/bookmarks

Create bookmark

create_bookmark body → 200

GET

/v1/users/self/bookmarks/{id}

Get bookmark

get_bookmark 1 param → 200

PUT

/v1/users/self/bookmarks/{id}

Update bookmark

update_bookmark 1 param body → 200

DELETE

/v1/users/self/bookmarks/{id}

Delete bookmark

delete_bookmark 1 param → 200

Brand Configs 3

GET

/v1/brand_variables

Get the brand config variables that should be used for this domain

get_brand_config_variables_that_should_be_used_for_this_domain → 200

GET

/v1/accounts/{account_id}/brand_variables

Get the brand config variables for a sub-account or course

get_brand_config_variables_for_sub_account_or_course_accounts 1 param → 200

GET

/v1/courses/{course_id}/brand_variables

Get the brand config variables for a sub-account or course

get_brand_config_variables_for_sub_account_or_course_courses 1 param → 200

Calendar Events 12

GET

/v1/calendar_events

List calendar events

list_calendar_events 10 params → 200

POST

/v1/calendar_events

Create a calendar event

create_calendar_event body → 200

GET

/v1/users/{user_id}/calendar_events

List calendar events for a user

list_calendar_events_for_user 13 params → 200

GET

/v1/calendar_events/{id}

Get a single calendar event or assignment

get_single_calendar_event_or_assignment 1 param → 200

PUT

/v1/calendar_events/{id}

Update a calendar event

update_calendar_event 1 param body → 200

DELETE

/v1/calendar_events/{id}

Delete a calendar event

delete_calendar_event 3 params → 200

POST

/v1/calendar_events/{id}/reservations

Reserve a time slot

reserve_time_slot 1 param body → 200

POST

/v1/calendar_events/{id}/reservations/{participant_id}

Reserve a time slot

reserve_time_slot_participant_id 2 params body → 200

POST

/v1/calendar_events/save_enabled_account_calendars

Save enabled account calendars

save_enabled_account_calendars body → 200

POST

/v1/courses/{course_id}/calendar_events/timetable

Set a course timetable

set_course_timetable 1 param body → 200

GET

/v1/courses/{course_id}/calendar_events/timetable

Get course timetable

get_course_timetable 1 param → 200

POST

/v1/courses/{course_id}/calendar_events/timetable_events

Create or update events directly for a course timetable

create_or_update_events_directly_for_course_timetable 1 param body → 200

Canvas Career Experiences 4

GET

/v1/career/enabled

Check if Canvas Career is enabled

check_if_canvas_career_is_enabled → 200

GET

/v1/career/experience_summary

Get current and available experiences

get_current_and_available_experiences → 200

POST

/v1/career/switch_experience

Switch experience

switch_experience body → 200

POST

/v1/career/switch_role

Switch role

switch_role body → 200

Canvas Career User Context 1

GET

/v1/career/user_context

Get career user context

get_career_user_context 1 param → 200

Collaborations 5

GET

/v1/courses/{course_id}/collaborations

List collaborations

list_collaborations_courses 1 param → 200

GET

/v1/groups/{group_id}/collaborations

List collaborations

list_collaborations_groups 1 param → 200

GET

/v1/collaborations/{id}/members

List members of a collaboration.

list_members_of_collaboration 2 params → 200

GET

/v1/courses/{course_id}/potential_collaborators

List potential members

list_potential_members_courses 1 param → 200

GET

/v1/groups/{group_id}/potential_collaborators

List potential members

list_potential_members_groups 1 param → 200

Comm Messages 1

GET

/v1/comm_messages

List of CommMessages for a user

list_of_commmessages_for_user 3 params → 200

Communication Channels 5

GET

/v1/users/{user_id}/communication_channels

List user communication channels

list_user_communication_channels 1 param → 200

POST

/v1/users/{user_id}/communication_channels

Create a communication channel

create_communication_channel 1 param body → 200

DELETE

/v1/users/{user_id}/communication_channels/{id}

Delete a communication channel

delete_communication_channel_id 2 params → 200

DELETE

/v1/users/{user_id}/communication_channels/{type}/{address}

Delete a communication channel

delete_communication_channel_type 3 params → 200

DELETE

/v1/users/self/communication_channels/push

Delete a push notification endpoint

delete_push_notification_endpoint → 200

Conferences 3

GET

/v1/courses/{course_id}/conferences

List conferences

list_conferences_courses 1 param → 200

GET

/v1/groups/{group_id}/conferences

List conferences

list_conferences_groups 1 param → 200

GET

/v1/conferences

List conferences for the current user

list_conferences_for_current_user 1 param → 200

Content Exports 9

GET

/v1/courses/{course_id}/content_exports

List content exports

list_content_exports_courses 1 param → 200

POST

/v1/courses/{course_id}/content_exports

Export content

export_content_courses 1 param body → 200

GET

/v1/groups/{group_id}/content_exports

List content exports

list_content_exports_groups 1 param → 200

POST

/v1/groups/{group_id}/content_exports

Export content

export_content_groups 1 param body → 200

GET

/v1/users/{user_id}/content_exports

List content exports

list_content_exports_users 1 param → 200

POST

/v1/users/{user_id}/content_exports

Export content

export_content_users 1 param body → 200

GET

/v1/courses/{course_id}/content_exports/{id}

Show content export

show_content_export_courses 2 params → 200

GET

/v1/groups/{group_id}/content_exports/{id}

Show content export

show_content_export_groups 2 params → 200

GET

/v1/users/{user_id}/content_exports/{id}

Show content export

show_content_export_users 2 params → 200

Content Migrations 37

GET

/v1/accounts/{account_id}/content_migrations/{content_migration_id}/migration_issues

List migration issues

list_migration_issues_accounts 2 params → 200

GET

/v1/courses/{course_id}/content_migrations/{content_migration_id}/migration_issues

List migration issues

list_migration_issues_courses 2 params → 200

GET

/v1/groups/{group_id}/content_migrations/{content_migration_id}/migration_issues

List migration issues

list_migration_issues_groups 2 params → 200

GET

/v1/users/{user_id}/content_migrations/{content_migration_id}/migration_issues

List migration issues

list_migration_issues_users 2 params → 200

GET

/v1/accounts/{account_id}/content_migrations/{content_migration_id}/migration_issues/{id}

Get a migration issue

get_migration_issue_accounts 3 params → 200

PUT

/v1/accounts/{account_id}/content_migrations/{content_migration_id}/migration_issues/{id}

Update a migration issue

update_migration_issue_accounts 3 params body → 200

GET

/v1/courses/{course_id}/content_migrations/{content_migration_id}/migration_issues/{id}

Get a migration issue

get_migration_issue_courses 3 params → 200

PUT

/v1/courses/{course_id}/content_migrations/{content_migration_id}/migration_issues/{id}

Update a migration issue

update_migration_issue_courses 3 params body → 200

GET

/v1/groups/{group_id}/content_migrations/{content_migration_id}/migration_issues/{id}

Get a migration issue

get_migration_issue_groups 3 params → 200

PUT

/v1/groups/{group_id}/content_migrations/{content_migration_id}/migration_issues/{id}

Update a migration issue

update_migration_issue_groups 3 params body → 200

GET

/v1/users/{user_id}/content_migrations/{content_migration_id}/migration_issues/{id}

Get a migration issue

get_migration_issue_users 3 params → 200

PUT

/v1/users/{user_id}/content_migrations/{content_migration_id}/migration_issues/{id}

Update a migration issue

update_migration_issue_users 3 params body → 200

GET

/v1/accounts/{account_id}/content_migrations

List content migrations

list_content_migrations_accounts 1 param → 200

POST

/v1/accounts/{account_id}/content_migrations

Create a content migration

create_content_migration_accounts 1 param body → 200

GET

/v1/courses/{course_id}/content_migrations

List content migrations

list_content_migrations_courses 1 param → 200

POST

/v1/courses/{course_id}/content_migrations

Create a content migration

create_content_migration_courses 1 param body → 200

GET

/v1/groups/{group_id}/content_migrations

List content migrations

list_content_migrations_groups 1 param → 200

POST

/v1/groups/{group_id}/content_migrations

Create a content migration

create_content_migration_groups 1 param body → 200

GET

/v1/users/{user_id}/content_migrations

List content migrations

list_content_migrations_users 1 param → 200

POST

/v1/users/{user_id}/content_migrations

Create a content migration

create_content_migration_users 1 param body → 200

GET

/v1/accounts/{account_id}/content_migrations/{id}

Get a content migration

get_content_migration_accounts 2 params → 200

PUT

/v1/accounts/{account_id}/content_migrations/{id}

Update a content migration

update_content_migration_accounts 2 params → 200

GET

/v1/courses/{course_id}/content_migrations/{id}

Get a content migration

get_content_migration_courses 2 params → 200

PUT

/v1/courses/{course_id}/content_migrations/{id}

Update a content migration

update_content_migration_courses 2 params → 200

GET

/v1/groups/{group_id}/content_migrations/{id}

Get a content migration

get_content_migration_groups 2 params → 200

PUT

/v1/groups/{group_id}/content_migrations/{id}

Update a content migration

update_content_migration_groups 2 params → 200

GET

/v1/users/{user_id}/content_migrations/{id}

Get a content migration

get_content_migration_users 2 params → 200

PUT

/v1/users/{user_id}/content_migrations/{id}

Update a content migration

update_content_migration_users 2 params → 200

GET

/v1/accounts/{account_id}/content_migrations/migrators

List Migration Systems

list_migration_systems_accounts 1 param → 200

GET

/v1/courses/{course_id}/content_migrations/migrators

List Migration Systems

list_migration_systems_courses 1 param → 200

GET

/v1/groups/{group_id}/content_migrations/migrators

List Migration Systems

list_migration_systems_groups 1 param → 200

GET

/v1/users/{user_id}/content_migrations/migrators

List Migration Systems

list_migration_systems_users 1 param → 200

GET

/v1/accounts/{account_id}/content_migrations/{id}/selective_data

List items for selective import

list_items_for_selective_import_accounts 3 params → 200

GET

/v1/courses/{course_id}/content_migrations/{id}/selective_data

List items for selective import

list_items_for_selective_import_courses 3 params → 200

GET

/v1/groups/{group_id}/content_migrations/{id}/selective_data

List items for selective import

list_items_for_selective_import_groups 3 params → 200

GET

/v1/users/{user_id}/content_migrations/{id}/selective_data

List items for selective import

list_items_for_selective_import_users 3 params → 200

GET

/v1/courses/{course_id}/content_migrations/{id}/asset_id_mapping

Get asset id mapping

get_asset_id_mapping 2 params → 200

Content Security Policy Settings 8

GET

/v1/courses/{course_id}/csp_settings

Get current settings for account or course

get_current_settings_for_account_or_course_courses 1 param → 200

PUT

/v1/courses/{course_id}/csp_settings

Enable, disable, or clear explicit CSP setting

enable_disable_or_clear_explicit_csp_setting_courses 1 param body → 200

GET

/v1/accounts/{account_id}/csp_settings

Get current settings for account or course

get_current_settings_for_account_or_course_accounts 1 param → 200

PUT

/v1/accounts/{account_id}/csp_settings

Enable, disable, or clear explicit CSP setting

enable_disable_or_clear_explicit_csp_setting_accounts 1 param body → 200

PUT

/v1/accounts/{account_id}/csp_settings/lock

Lock or unlock current CSP settings for sub-accounts and courses

lock_or_unlock_current_csp_settings_for_sub_accounts_and_courses 1 param body → 200

POST

/v1/accounts/{account_id}/csp_settings/domains

Add an allowed domain to account

add_allowed_domain_to_account 1 param body → 200

DELETE

/v1/accounts/{account_id}/csp_settings/domains

Remove a domain from account

remove_domain_from_account 2 params → 200

POST

/v1/accounts/{account_id}/csp_settings/domains/batch_create

Add multiple allowed domains to an account

add_multiple_allowed_domains_to_account 1 param body → 200

Content Shares 8

POST

/v1/users/{user_id}/content_shares

Create a content share

create_content_share 1 param body → 200

GET

/v1/users/{user_id}/content_shares/sent

List content shares

list_content_shares_sent 1 param → 200

GET

/v1/users/{user_id}/content_shares/received

List content shares

list_content_shares_received 1 param → 200

GET

/v1/users/{user_id}/content_shares/unread_count

Get unread shares count

get_unread_shares_count 1 param → 200

GET

/v1/users/{user_id}/content_shares/{id}

Get content share

get_content_share 2 params → 200

DELETE

/v1/users/{user_id}/content_shares/{id}

Remove content share

remove_content_share 2 params → 200

PUT

/v1/users/{user_id}/content_shares/{id}

Update a content share

update_content_share 2 params body → 200

POST

/v1/users/{user_id}/content_shares/{id}/add_users

Add users to content share

add_users_to_content_share 2 params body → 200

Conversations 12

GET

/v1/conversations

List conversations

list_conversations 6 params → 200

POST

/v1/conversations

Create a conversation

create_conversation body → 200

PUT

/v1/conversations

Batch update conversations

batch_update_conversations body → 200

GET

/v1/conversations/batches

Get running batches

get_running_batches → 200

GET

/v1/conversations/{id}

Get a single conversation

get_single_conversation 6 params → 200

PUT

/v1/conversations/{id}

Edit a conversation

edit_conversation 1 param body → 200

DELETE

/v1/conversations/{id}

Delete a conversation

delete_conversation 1 param → 200

POST

/v1/conversations/mark_all_as_read

Mark all as read

mark_all_as_read → 200

POST

/v1/conversations/{id}/add_recipients

Add recipients

add_recipients 1 param body → 200

POST

/v1/conversations/{id}/add_message

Add a message

add_message 1 param body → 200

POST

/v1/conversations/{id}/remove_messages

Delete a message

delete_message 1 param body → 200

GET

/v1/conversations/unread_count

Unread count

unread_count → 200

Search 3

GET

/v1/conversations/find_recipients

Find recipients

find_recipients_conversations 7 params → 200

GET

/v1/search/recipients

Find recipients

find_recipients_search 7 params → 200

GET

/v1/search/all_courses

List all courses

list_all_courses 3 params → 200

Course Audit Log 2

GET

/v1/audit/course/courses/{course_id}

Query by course.

query_by_course 3 params → 200

GET

/v1/audit/course/accounts/{account_id}

Query by account.

query_by_account_course_audit_log 3 params → 200

Course Pace 4

GET

/v1/courses/{course_id}/course_pacing/{id}

Show a Course pace

show_course_pace 3 params → 200

PUT

/v1/courses/{course_id}/course_pacing/{id}

Update a Course pace

update_course_pace 2 params body → 200

DELETE

/v1/courses/{course_id}/course_pacing/{id}

Delete a Course pace

delete_course_pace 3 params → 200

POST

/v1/courses/{course_id}/course_pacing

Create a Course pace

create_course_pace 1 param body → 200

Course Quiz Extensions 1

POST

/v1/courses/{course_id}/quiz_extensions

Set extensions for student quiz submissions

set_extensions_for_student_quiz_submissions 1 param body → 200

Course Reports 3

GET

/v1/courses/{course_id}/reports/{report_type}/{id}

Status of a Report

status_of_report_course_reports 3 params → 200

POST

/v1/courses/{course_id}/reports/{report_type}

Start a Report

start_report_course_reports 2 params body → 200

GET

/v1/courses/{course_id}/reports/{report_type}

Status of last Report

status_of_last_report 2 params → 200

Files 53

GET

/v1/courses/{course_id}/files

List files

list_files_courses 8 params → 200

GET

/v1/courses/{course_id}/files/quota

Get quota information

get_quota_information_courses 1 param → 200

GET

/v1/groups/{group_id}/files/quota

Get quota information

get_quota_information_groups 1 param → 200

GET

/v1/users/{user_id}/files/quota

Get quota information

get_quota_information_users 1 param → 200

GET

/v1/users/{user_id}/files

List files

list_files_users 8 params → 200

GET

/v1/groups/{group_id}/files

List files

list_files_groups 8 params → 200

GET

/v1/folders/{id}/files

List files

list_files_folders 8 params → 200

GET

/v1/files/{id}/public_url

Get public inline preview url

get_public_inline_preview_url 2 params → 200

GET

/v1/files/{id}

Get file

get_file_files 4 params → 200

PUT

/v1/files/{id}

Update file

update_file 1 param body → 200

DELETE

/v1/files/{id}

Delete file

delete_file 2 params → 200

GET

/v1/courses/{course_id}/files/{id}

Get file

get_file_courses 5 params → 200

GET

/v1/groups/{group_id}/files/{id}

Get file

get_file_groups 5 params → 200

GET

/v1/users/{user_id}/files/{id}

Get file

get_file_users 5 params → 200

GET

/v1/courses/{course_id}/files/file_ref/{migration_id}

Translate file reference

translate_file_reference 2 params → 200

GET

/v1/files/{id}/icon_metadata

Get icon metadata

get_icon_metadata 1 param → 200

POST

/v1/files/{id}/reset_verifierdeprecated

Reset link verifier

reset_link_verifier 1 param → 200

POST

/v1/files/update_word_count

Update word count

update_word_count body → 200

GET

/v1/folders/{id}/folders

List folders

list_folders 1 param → 200

GET

/v1/courses/{course_id}/folders

List all folders

list_all_folders_courses 1 param → 200

POST

/v1/courses/{course_id}/folders

Create folder

create_folder_courses 1 param body → 200

GET

/v1/users/{user_id}/folders

List all folders

list_all_folders_users 1 param → 200

POST

/v1/users/{user_id}/folders

Create folder

create_folder_users 1 param body → 200

GET

/v1/groups/{group_id}/folders

List all folders

list_all_folders_groups 1 param → 200

POST

/v1/groups/{group_id}/folders

Create folder

create_folder_groups 1 param body → 200

GET

/v1/courses/{course_id}/folders/by_path/*full_path

Resolve path

resolve_path_courses_full_path 1 param → 200

GET

/v1/courses/{course_id}/folders/by_path

Resolve path

resolve_path_courses 1 param → 200

GET

/v1/users/{user_id}/folders/by_path/*full_path

Resolve path

resolve_path_users_full_path 1 param → 200

GET

/v1/users/{user_id}/folders/by_path

Resolve path

resolve_path_users 1 param → 200

GET

/v1/groups/{group_id}/folders/by_path/*full_path

Resolve path

resolve_path_groups_full_path 1 param → 200

GET

/v1/groups/{group_id}/folders/by_path

Resolve path

resolve_path_groups 1 param → 200

GET

/v1/courses/{course_id}/folders/{id}

Get folder

get_folder_courses 2 params → 200

GET

/v1/users/{user_id}/folders/{id}

Get folder

get_folder_users 2 params → 200

GET

/v1/groups/{group_id}/folders/{id}

Get folder

get_folder_groups 2 params → 200

GET

/v1/folders/{id}

Get folder

get_folder_folders 1 param → 200

PUT

/v1/folders/{id}

Update folder

update_folder 1 param body → 200

DELETE

/v1/folders/{id}

Delete folder

delete_folder 2 params → 200

POST

/v1/folders/{folder_id}/folders

Create folder

create_folder_folders 1 param body → 200

POST

/v1/accounts/{account_id}/folders

Create folder

create_folder_accounts 1 param body → 200

POST

/v1/folders/{folder_id}/files

Upload a file

upload_file_files 1 param → 200

POST

/v1/folders/{dest_folder_id}/copy_file

Copy a file

copy_file 1 param body → 200

POST

/v1/folders/{dest_folder_id}/copy_folder

Copy a folder

copy_folder 1 param body → 200

GET

/v1/courses/{course_id}/folders/media

Get uploaded media folder for user

get_uploaded_media_folder_for_user_courses 1 param → 200

GET

/v1/groups/{group_id}/folders/media

Get uploaded media folder for user

get_uploaded_media_folder_for_user_groups 1 param → 200

PUT

/v1/courses/{course_id}/usage_rights

Set usage rights

set_usage_rights_courses 1 param body → 200

DELETE

/v1/courses/{course_id}/usage_rights

Remove usage rights

remove_usage_rights_courses 3 params → 200

PUT

/v1/groups/{group_id}/usage_rights

Set usage rights

set_usage_rights_groups 1 param body → 200

DELETE

/v1/groups/{group_id}/usage_rights

Remove usage rights

remove_usage_rights_groups 3 params → 200

PUT

/v1/users/{user_id}/usage_rights

Set usage rights

set_usage_rights_users 1 param body → 200

DELETE

/v1/users/{user_id}/usage_rights

Remove usage rights

remove_usage_rights_users 3 params → 200

GET

/v1/courses/{course_id}/content_licenses

List licenses

list_licenses_courses 1 param → 200

GET

/v1/groups/{group_id}/content_licenses

List licenses

list_licenses_groups 1 param → 200

GET

/v1/users/{user_id}/content_licenses

List licenses

list_licenses_users 1 param → 200

Custom Gradebook Columns 8

GET

/v1/courses/{course_id}/custom_gradebook_columns

List custom gradebook columns

list_custom_gradebook_columns 2 params → 200

POST

/v1/courses/{course_id}/custom_gradebook_columns

Create a custom gradebook column

create_custom_gradebook_column 1 param body → 200

PUT

/v1/courses/{course_id}/custom_gradebook_columns/{id}

Update a custom gradebook column

update_custom_gradebook_column 2 params → 200

DELETE

/v1/courses/{course_id}/custom_gradebook_columns/{id}

Delete a custom gradebook column

delete_custom_gradebook_column 2 params → 200

POST

/v1/courses/{course_id}/custom_gradebook_columns/reorder

Reorder custom columns

reorder_custom_columns 1 param body → 200

GET

/v1/courses/{course_id}/custom_gradebook_columns/{id}/data

List entries for a column

list_entries_for_column 3 params → 200

PUT

/v1/courses/{course_id}/custom_gradebook_columns/{id}/data/{user_id}

Update column data

update_column_data 3 params body → 200

PUT

/v1/courses/{course_id}/custom_gradebook_column_data

Bulk update column data

bulk_update_column_data 1 param body → 200

Developer Key Account Bindings 1

POST

/v1/accounts/{account_id}/developer_keys/{developer_key_id}/developer_key_account_bindings

Create a Developer Key Account Binding

create_developer_key_account_binding 2 params body → 200

Developer Keys 5

GET

/v1/accounts/{account_id}/developer_keys

List Developer Keys

list_developer_keys 2 params → 200

POST

/v1/accounts/{account_id}/developer_keys

Create a Developer Key

create_developer_key 1 param body → 200

PUT

/v1/developer_keys/{id}

Update a Developer Key

update_developer_key 1 param body → 200

DELETE

/v1/developer_keys/{id}

Delete a Developer Key

delete_developer_key 1 param → 200

POST

/v1/developer_keys/{id}/regenerate_secret

Regenerate Developer Key Secret

regenerate_developer_key_secret 1 param → 200

Discovery Pages 3

GET

/v1/discovery_pages

Get Discovery Page

get_discovery_page → 200

PUT

/v1/discovery_pages

Update Discovery Page

update_discovery_page body → 200

POST

/v1/discovery_pages/token

Generate Discovery Page Preview Token

generate_discovery_page_preview_token body → 200

Discussion Topics 58

GET

/v1/courses/{course_id}/discussion_topics

List discussion topics

list_discussion_topics_courses 8 params → 200

POST

/v1/courses/{course_id}/discussion_topics

Create a new discussion topic

create_new_discussion_topic_courses 1 param body → 200

GET

/v1/groups/{group_id}/discussion_topics

List discussion topics

list_discussion_topics_groups 8 params → 200

POST

/v1/groups/{group_id}/discussion_topics

Create a new discussion topic

create_new_discussion_topic_groups 1 param body → 200

PUT

/v1/courses/{course_id}/discussion_topics/{topic_id}

Update a topic

update_topic_courses 2 params body → 200

DELETE

/v1/courses/{course_id}/discussion_topics/{topic_id}

Delete a topic

delete_topic_courses 2 params → 200

GET

/v1/courses/{course_id}/discussion_topics/{topic_id}

Get a single topic

get_single_topic_courses 3 params → 200

PUT

/v1/groups/{group_id}/discussion_topics/{topic_id}

Update a topic

update_topic_groups 2 params body → 200

DELETE

/v1/groups/{group_id}/discussion_topics/{topic_id}

Delete a topic

delete_topic_groups 2 params → 200

GET

/v1/groups/{group_id}/discussion_topics/{topic_id}

Get a single topic

get_single_topic_groups 3 params → 200

POST

/v1/courses/{course_id}/discussion_topics/reorder

Reorder pinned topics

reorder_pinned_topics_courses 1 param body → 200

POST

/v1/groups/{group_id}/discussion_topics/reorder

Reorder pinned topics

reorder_pinned_topics_groups 1 param body → 200

PUT

/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{id}

Update an entry

update_entry_courses 3 params body → 200

DELETE

/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{id}

Delete an entry

delete_entry_courses 3 params → 200

PUT

/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{id}

Update an entry

update_entry_groups 3 params body → 200

DELETE

/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{id}

Delete an entry

delete_entry_groups 3 params → 200

GET

/v1/courses/{course_id}/discussion_topics/{topic_id}/summaries

Find Last Summary

find_last_summary_courses 2 params → 200

POST

/v1/courses/{course_id}/discussion_topics/{topic_id}/summaries

Find or Create Summary

find_or_create_summary_courses 2 params body → 200

GET

/v1/groups/{group_id}/discussion_topics/{topic_id}/summaries

Find Last Summary

find_last_summary_groups 2 params → 200

POST

/v1/groups/{group_id}/discussion_topics/{topic_id}/summaries

Find or Create Summary

find_or_create_summary_groups 2 params body → 200

PUT

/v1/courses/{course_id}/discussion_topics/{topic_id}/summaries/disable

Disable summary

disable_summary_courses 2 params → 200

PUT

/v1/groups/{group_id}/discussion_topics/{topic_id}/summaries/disable

Disable summary

disable_summary_groups 2 params → 200

POST

/v1/courses/{course_id}/discussion_topics/{topic_id}/summaries/{summary_id}/feedback

Summary Feedback

summary_feedback_courses 3 params body → 200

POST

/v1/groups/{group_id}/discussion_topics/{topic_id}/summaries/{summary_id}/feedback

Summary Feedback

summary_feedback_groups 3 params body → 200

GET

/v1/courses/{course_id}/discussion_topics/{topic_id}/view

Get the full topic

get_full_topic_courses 2 params → 200

GET

/v1/groups/{group_id}/discussion_topics/{topic_id}/view

Get the full topic

get_full_topic_groups 2 params → 200

POST

/v1/courses/{course_id}/discussion_topics/{topic_id}/entries

Post an entry

post_entry_courses 2 params body → 200

GET

/v1/courses/{course_id}/discussion_topics/{topic_id}/entries

List topic entries

list_topic_entries_courses 2 params → 200

POST

/v1/groups/{group_id}/discussion_topics/{topic_id}/entries

Post an entry

post_entry_groups 2 params body → 200

GET

/v1/groups/{group_id}/discussion_topics/{topic_id}/entries

List topic entries

list_topic_entries_groups 2 params → 200

POST

/v1/courses/{course_id}/discussion_topics/{topic_id}/duplicate

Duplicate discussion topic

duplicate_discussion_topic_courses 2 params → 200

POST

/v1/groups/{group_id}/discussion_topics/{topic_id}/duplicate

Duplicate discussion topic

duplicate_discussion_topic_groups 2 params → 200

POST

/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/replies

Post a reply

post_reply_courses 3 params body → 200

GET

/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/replies

List entry replies

list_entry_replies_courses 3 params → 200

POST

/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/replies

Post a reply

post_reply_groups 3 params body → 200

GET

/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/replies

List entry replies

list_entry_replies_groups 3 params → 200

GET

/v1/courses/{course_id}/discussion_topics/{topic_id}/entry_list

List entries

list_entries_courses 3 params → 200

GET

/v1/groups/{group_id}/discussion_topics/{topic_id}/entry_list

List entries

list_entries_groups 3 params → 200

PUT

/v1/courses/{course_id}/discussion_topics/{topic_id}/read

Mark topic as read

mark_topic_as_read_courses 2 params → 200

DELETE

/v1/courses/{course_id}/discussion_topics/{topic_id}/read

Mark topic as unread

mark_topic_as_unread_courses 2 params → 200

PUT

/v1/groups/{group_id}/discussion_topics/{topic_id}/read

Mark topic as read

mark_topic_as_read_groups 2 params → 200

DELETE

/v1/groups/{group_id}/discussion_topics/{topic_id}/read

Mark topic as unread

mark_topic_as_unread_groups 2 params → 200

PUT

/v1/courses/{course_id}/discussion_topics/read_all

Mark all topic as read

mark_all_topic_as_read_courses 1 param → 200

PUT

/v1/groups/{group_id}/discussion_topics/read_all

Mark all topic as read

mark_all_topic_as_read_groups 1 param → 200

PUT

/v1/courses/{course_id}/discussion_topics/{topic_id}/read_all

Mark all entries as read

mark_all_entries_as_read_courses 2 params body → 200

DELETE

/v1/courses/{course_id}/discussion_topics/{topic_id}/read_all

Mark all entries as unread

mark_all_entries_as_unread_courses 3 params → 200

PUT

/v1/groups/{group_id}/discussion_topics/{topic_id}/read_all

Mark all entries as read

mark_all_entries_as_read_groups 2 params body → 200

DELETE

/v1/groups/{group_id}/discussion_topics/{topic_id}/read_all

Mark all entries as unread

mark_all_entries_as_unread_groups 3 params → 200

PUT

/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/read

Mark entry as read

mark_entry_as_read_courses 3 params body → 200

DELETE

/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/read

Mark entry as unread

mark_entry_as_unread_courses 4 params → 200

PUT

/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/read

Mark entry as read

mark_entry_as_read_groups 3 params body → 200

DELETE

/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/read

Mark entry as unread

mark_entry_as_unread_groups 4 params → 200

POST

/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/rating

Rate entry

rate_entry_courses 3 params body → 200

POST

/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/rating

Rate entry

rate_entry_groups 3 params body → 200

PUT

/v1/courses/{course_id}/discussion_topics/{topic_id}/subscribed

Subscribe to a topic

subscribe_to_topic_courses 2 params → 200

DELETE

/v1/courses/{course_id}/discussion_topics/{topic_id}/subscribed

Unsubscribe from a topic

unsubscribe_from_topic_courses 2 params → 200

PUT

/v1/groups/{group_id}/discussion_topics/{topic_id}/subscribed

Subscribe to a topic

subscribe_to_topic_groups 2 params → 200

DELETE

/v1/groups/{group_id}/discussion_topics/{topic_id}/subscribed

Unsubscribe from a topic

unsubscribe_from_topic_groups 2 params → 200

E Portfolios 7

GET

/v1/users/{user_id}/eportfolios

Get all ePortfolios for a User

get_all_eportfolios_for_user 2 params → 200

PUT

/v1/users/{user_id}/eportfolios

Moderate all ePortfolios for a User

moderate_all_eportfolios_for_user 1 param body → 200

GET

/v1/eportfolios/{id}

Get an ePortfolio

get_eportfolio 1 param → 200

DELETE

/v1/eportfolios/{id}

Delete an ePortfolio

delete_eportfolio 1 param → 200

GET

/v1/eportfolios/{eportfolio_id}/pages

Get ePortfolio Pages

get_eportfolio_pages 1 param → 200

PUT

/v1/eportfolios/{eportfolio_id}/moderate

Moderate an ePortfolio

moderate_eportfolio 1 param body → 200

PUT

/v1/eportfolios/{eportfolio_id}/restore

Restore a deleted ePortfolio

restore_deleted_eportfolio 1 param → 200

E Pub Exports 3

GET

/v1/epub_exports

List courses with their latest ePub export

list_courses_with_their_latest_epub_export → 200

POST

/v1/courses/{course_id}/epub_exports

Create ePub Export

create_epub_export 1 param → 200

GET

/v1/courses/{course_id}/epub_exports/{id}

Show ePub export

show_epub_export 2 params → 200

Enrollment Terms 5

POST

/v1/accounts/{account_id}/terms

Create enrollment term

create_enrollment_term 1 param body → 200

GET

/v1/accounts/{account_id}/terms

List enrollment terms

list_enrollment_terms 4 params → 200

PUT

/v1/accounts/{account_id}/terms/{id}

Update enrollment term

update_enrollment_term 2 params body → 200

DELETE

/v1/accounts/{account_id}/terms/{id}

Delete enrollment term

delete_enrollment_term 2 params → 200

GET

/v1/accounts/{account_id}/terms/{id}

Retrieve enrollment term

retrieve_enrollment_term 2 params → 200

Enrollments 14

GET

/v1/courses/{course_id}/enrollments

List enrollments

list_enrollments_courses 13 params → 200

POST

/v1/courses/{course_id}/enrollments

Enroll a user

enroll_user_courses 1 param body → 200

GET

/v1/sections/{section_id}/enrollments

List enrollments

list_enrollments_sections 13 params → 200

POST

/v1/sections/{section_id}/enrollments

Enroll a user

enroll_user_sections 1 param body → 200

GET

/v1/users/{user_id}/enrollments

List enrollments

list_enrollments_users 12 params → 200

GET

/v1/accounts/{account_id}/enrollments/{id}

Enrollment by ID

enrollment_by_id 2 params → 200

POST

/v1/accounts/{account_id}/bulk_enrollment

Enroll multiple users to one or more courses

enroll_multiple_users_to_one_or_more_courses 1 param body → 200

DELETE

/v1/courses/{course_id}/enrollments/{id}

Conclude, deactivate, or delete an enrollment

conclude_deactivate_or_delete_enrollment 3 params → 200

POST

/v1/courses/{course_id}/enrollments/{id}/accept

Accept Course Invitation

accept_course_invitation 2 params → 200

POST

/v1/courses/{course_id}/enrollments/{id}/reject

Reject Course Invitation

reject_course_invitation 2 params → 200

PUT

/v1/courses/{course_id}/enrollments/{id}/reactivate

Re-activate an enrollment

re_activate_enrollment 2 params → 200

PUT

/v1/courses/{course_id}/users/{user_id}/last_attended

Add last attended date

add_last_attended_date 2 params body → 200

GET

/v1/users/{user_id}/temporary_enrollment_status

Show Temporary Enrollment recipient and provider status

show_temporary_enrollment_recipient_and_provider_status 2 params → 200

GET

/v1/temporary_enrollment_status

Bulk Temporary Enrollment Status

bulk_temporary_enrollment_status 3 params → 200

Error Reports 1

POST

/v1/error_reports

Create Error Report

create_error_report body → 200

External Tools 19

GET

/v1/courses/{course_id}/external_tools

List external tools

list_external_tools_courses 5 params → 200

POST

/v1/courses/{course_id}/external_tools

Create an external tool

create_external_tool_courses 1 param body → 200

GET

/v1/accounts/{account_id}/external_tools

List external tools

list_external_tools_accounts 5 params → 200

POST

/v1/accounts/{account_id}/external_tools

Create an external tool

create_external_tool_accounts 1 param body → 200

GET

/v1/groups/{group_id}/external_tools

List external tools

list_external_tools_groups 5 params → 200

GET

/v1/courses/{course_id}/external_tools/sessionless_launch

Get a sessionless launch url for an external tool.

get_sessionless_launch_url_for_external_tool_courses 7 params → 200

GET

/v1/accounts/{account_id}/external_tools/sessionless_launch

Get a sessionless launch url for an external tool.

get_sessionless_launch_url_for_external_tool_accounts 7 params → 200

GET

/v1/courses/{course_id}/external_tools/{external_tool_id}

Get a single external tool

get_single_external_tool_courses 2 params → 200

PUT

/v1/courses/{course_id}/external_tools/{external_tool_id}

Edit an external tool

edit_external_tool_courses 2 params → 200

DELETE

/v1/courses/{course_id}/external_tools/{external_tool_id}

Delete an external tool

delete_external_tool_courses 2 params → 200

GET

/v1/accounts/{account_id}/external_tools/{external_tool_id}

Get a single external tool

get_single_external_tool_accounts 2 params → 200

PUT

/v1/accounts/{account_id}/external_tools/{external_tool_id}

Edit an external tool

edit_external_tool_accounts 2 params → 200

DELETE

/v1/accounts/{account_id}/external_tools/{external_tool_id}

Delete an external tool

delete_external_tool_accounts 2 params → 200

POST

/v1/accounts/{account_id}/external_tools/rce_favorites/{id}

Mark tool as RCE Favorite

mark_tool_as_rce_favorite 2 params → 200

DELETE

/v1/accounts/{account_id}/external_tools/rce_favorites/{id}

Unmark tool as RCE Favorite

unmark_tool_as_rce_favorite 2 params → 200

POST

/v1/accounts/{account_id}/external_tools/top_nav_favorites/{id}

Add tool to Top Navigation Favorites

add_tool_to_top_navigation_favorites 2 params → 200

DELETE

/v1/accounts/{account_id}/external_tools/top_nav_favorites/{id}

Remove tool from Top Navigation Favorites

remove_tool_from_top_navigation_favorites 2 params → 200

GET

/v1/external_tools/visible_course_nav_tools

Get visible course navigation tools

get_visible_course_navigation_tools 1 param → 200

GET

/v1/courses/{course_id}/external_tools/visible_course_nav_tools

Get visible course navigation tools for a single course

get_visible_course_navigation_tools_for_single_course 1 param → 200

Favorites 8

GET

/v1/users/self/favorites/courses

List favorite courses

list_favorite_courses 1 param → 200

DELETE

/v1/users/self/favorites/courses

Reset course favorites

reset_course_favorites → 200

GET

/v1/users/self/favorites/groups

List favorite groups

list_favorite_groups → 200

DELETE

/v1/users/self/favorites/groups

Reset group favorites

reset_group_favorites → 200

POST

/v1/users/self/favorites/courses/{id}

Add course to favorites

add_course_to_favorites 1 param → 200

DELETE

/v1/users/self/favorites/courses/{id}

Remove course from favorites

remove_course_from_favorites 1 param → 200

POST

/v1/users/self/favorites/groups/{id}

Add group to favorites

add_group_to_favorites 1 param → 200

DELETE

/v1/users/self/favorites/groups/{id}

Remove group from favorites

remove_group_from_favorites 1 param → 200

Feature Flags 16

GET

/v1/courses/{course_id}/features

List features

list_features_courses 2 params → 200

GET

/v1/accounts/{account_id}/features

List features

list_features_accounts 2 params → 200

GET

/v1/users/{user_id}/features

List features

list_features_users 2 params → 200

GET

/v1/courses/{course_id}/features/enabled

List enabled features

list_enabled_features_courses 1 param → 200

GET

/v1/accounts/{account_id}/features/enabled

List enabled features

list_enabled_features_accounts 1 param → 200

GET

/v1/users/{user_id}/features/enabled

List enabled features

list_enabled_features_users 1 param → 200

GET

/v1/features/environment

List environment features

list_environment_features → 200

GET

/v1/courses/{course_id}/features/flags/{feature}

Get feature flag

get_feature_flag_courses 2 params → 200

PUT

/v1/courses/{course_id}/features/flags/{feature}

Set feature flag

set_feature_flag_courses 2 params body → 200

DELETE

/v1/courses/{course_id}/features/flags/{feature}

Remove feature flag

remove_feature_flag_courses 2 params → 200

GET

/v1/accounts/{account_id}/features/flags/{feature}

Get feature flag

get_feature_flag_accounts 2 params → 200

PUT

/v1/accounts/{account_id}/features/flags/{feature}

Set feature flag

set_feature_flag_accounts 2 params body → 200

DELETE

/v1/accounts/{account_id}/features/flags/{feature}

Remove feature flag

remove_feature_flag_accounts 2 params → 200

GET

/v1/users/{user_id}/features/flags/{feature}

Get feature flag

get_feature_flag_users 2 params → 200

PUT

/v1/users/{user_id}/features/flags/{feature}

Set feature flag

set_feature_flag_users 2 params body → 200

DELETE

/v1/users/{user_id}/features/flags/{feature}

Remove feature flag

remove_feature_flag_users 2 params → 200

Groups 25

POST

/v1/groups/{group_id}/files

Upload a file

upload_file_groups 1 param → 200

POST

/v1/group_categories/{group_category_id}/groups

Create a group

create_group_group_categories 1 param body → 200

GET

/v1/users/self/groups

List your groups

list_your_groups 2 params → 200

GET

/v1/accounts/{account_id}/groups

List the groups available in a context.

list_groups_available_in_context_accounts 4 params → 200

GET

/v1/courses/{course_id}/groups

List the groups available in a context.

list_groups_available_in_context_courses 4 params → 200

GET

/v1/courses/{course_id}/bulk_user_tags

Bulk fetch user tags for multiple users in a course

bulk_fetch_user_tags_for_multiple_users_in_course 2 params → 200

GET

/v1/groups/{group_id}

Get a single group

get_single_group 2 params → 200

PUT

/v1/groups/{group_id}

Edit a group

edit_group 1 param body → 200

DELETE

/v1/groups/{group_id}

Delete a group

delete_group 1 param → 200

POST

/v1/groups

Create a group

create_group_groups body → 200

POST

/v1/groups/{group_id}/invite

Invite others to a group

invite_others_to_group 1 param body → 200

GET

/v1/groups/{group_id}/users

List group's users

list_group_s_users 4 params → 200

DELETE

/v1/groups/{group_id}/users

Bulk delete memberships Bulk deletes memberships by providing an array of user IDs, or, for differentiation tag groups, by providing allingroupcourse to remove every course student matching an option…

bulk_delete_memberships_bulk_deletes_memberships_by_providing_array_of_user_ids_or_for_differentiation_tag_groups_by_providing_all_in_group_course_to_remove_every_course_student_matching_optional_role_tag_filter 6 params → 200

POST

/v1/groups/{group_id}/preview_html

Preview processed html

preview_processed_html_groups 1 param body → 200

GET

/v1/groups/{group_id}/activity_stream

Group activity stream

group_activity_stream 1 param → 200

GET

/v1/groups/{group_id}/activity_stream/summary

Group activity stream summary

group_activity_stream_summary 1 param → 200

GET

/v1/groups/{group_id}/permissions

Permissions

permissions_groups 2 params → 200

GET

/v1/groups/{group_id}/memberships

List group memberships

list_group_memberships 2 params → 200

POST

/v1/groups/{group_id}/memberships

Create a membership

create_membership 1 param body → 200

GET

/v1/groups/{group_id}/memberships/{membership_id}

Get a single group membership

get_single_group_membership_memberships 2 params → 200

PUT

/v1/groups/{group_id}/memberships/{membership_id}

Update a membership

update_membership_memberships 2 params body → 200

DELETE

/v1/groups/{group_id}/memberships/{membership_id}

Leave a group

leave_group_memberships 2 params → 200

GET

/v1/groups/{group_id}/users/{user_id}

Get a single group membership

get_single_group_membership_users 2 params → 200

PUT

/v1/groups/{group_id}/users/{user_id}

Update a membership

update_membership_users 2 params body → 200

DELETE

/v1/groups/{group_id}/users/{user_id}

Leave a group

leave_group_users 2 params → 200

Grade Change Log 5

GET

/v1/audit/grade_change/assignments/{assignment_id}

Query by assignment

query_by_assignment 3 params → 200

GET

/v1/audit/grade_change/courses/{course_id}

Query by course

query_by_course_grade_change_log 3 params → 200

GET

/v1/audit/grade_change/students/{student_id}

Query by student

query_by_student 3 params → 200

GET

/v1/audit/grade_change/graders/{grader_id}

Query by grader

query_by_grader 3 params → 200

GET

/v1/audit/grade_change

Advanced query

advanced_query 6 params → 200

Gradebook History 4

GET

/v1/courses/{course_id}/gradebook_history/days

Days in gradebook history for this course

days_in_gradebook_history_for_this_course 1 param → 200

GET

/v1/courses/{course_id}/gradebook_history/{date}

Details for a given date in gradebook history for this course

details_for_given_date_in_gradebook_history_for_this_course 2 params → 200

GET

/v1/courses/{course_id}/gradebook_history/{date}/graders/{grader_id}/assignments/{assignment_id}/submissions

Lists submissions

lists_submissions 4 params → 200

GET

/v1/courses/{course_id}/gradebook_history/feed

List uncollated submission versions

list_uncollated_submission_versions 4 params → 200

Grading Period Sets 4

GET

/v1/accounts/{account_id}/grading_period_sets

List grading period sets

list_grading_period_sets 1 param → 200

POST

/v1/accounts/{account_id}/grading_period_sets

Create a grading period set

create_grading_period_set 1 param body → 200

PATCH

/v1/accounts/{account_id}/grading_period_sets/{id}

Update a grading period set

update_grading_period_set 2 params body → 200

DELETE

/v1/accounts/{account_id}/grading_period_sets/{id}

Delete a grading period set

delete_grading_period_set 2 params → 200

Grading Periods 8

GET

/v1/accounts/{account_id}/grading_periods

List grading periods

list_grading_periods_accounts 1 param → 200

GET

/v1/courses/{course_id}/grading_periods

List grading periods

list_grading_periods_courses 1 param → 200

GET

/v1/courses/{course_id}/grading_periods/{id}

Get a single grading period

get_single_grading_period 2 params → 200

PUT

/v1/courses/{course_id}/grading_periods/{id}

Update a single grading period

update_single_grading_period 2 params body → 200

DELETE

/v1/courses/{course_id}/grading_periods/{id}

Delete a grading period

delete_grading_period_courses 2 params → 200

DELETE

/v1/accounts/{account_id}/grading_periods/{id}

Delete a grading period

delete_grading_period_accounts 2 params → 200

PATCH

/v1/courses/{course_id}/grading_periods/batch_update

Batch update grading periods

batch_update_grading_periods_courses 1 param body → 200

PATCH

/v1/grading_period_sets/{set_id}/grading_periods/batch_update

Batch update grading periods

batch_update_grading_periods_grading_period_sets 1 param body → 200

Grading Standards 10

POST

/v1/accounts/{account_id}/grading_standards

Create a new grading standard

create_new_grading_standard_accounts 1 param body → 200

GET

/v1/accounts/{account_id}/grading_standards

List the grading standards available in a context.

list_grading_standards_available_in_context_accounts 1 param → 200

POST

/v1/courses/{course_id}/grading_standards

Create a new grading standard

create_new_grading_standard_courses 1 param body → 200

GET

/v1/courses/{course_id}/grading_standards

List the grading standards available in a context.

list_grading_standards_available_in_context_courses 1 param → 200

GET

/v1/courses/{course_id}/grading_standards/{grading_standard_id}

Get a single grading standard in a context.

get_single_grading_standard_in_context_courses 2 params → 200

PUT

/v1/courses/{course_id}/grading_standards/{grading_standard_id}

Update a grading standard

update_grading_standard_courses 2 params body → 200

DELETE

/v1/courses/{course_id}/grading_standards/{grading_standard_id}

Delete a grading standard

delete_grading_standard_courses 2 params → 200

GET

/v1/accounts/{account_id}/grading_standards/{grading_standard_id}

Get a single grading standard in a context.

get_single_grading_standard_in_context_accounts 2 params → 200

PUT

/v1/accounts/{account_id}/grading_standards/{grading_standard_id}

Update a grading standard

update_grading_standard_accounts 2 params body → 200

DELETE

/v1/accounts/{account_id}/grading_standards/{grading_standard_id}

Delete a grading standard

delete_grading_standard_accounts 2 params → 200

Group Categories 16

GET

/v1/accounts/{account_id}/group_categories

List group categories for a context

list_group_categories_for_context_accounts 2 params → 200

POST

/v1/accounts/{account_id}/group_categories

Create a Group Category

create_group_category_accounts 1 param body → 200

GET

/v1/courses/{course_id}/group_categories

List group categories for a context

list_group_categories_for_context_courses 2 params → 200

POST

/v1/courses/{course_id}/group_categories

Create a Group Category

create_group_category_courses 1 param body → 200

GET

/v1/group_categories/{group_category_id}

Get a single group category

get_single_group_category 1 param → 200

PUT

/v1/group_categories/{group_category_id}

Update a Group Category

update_group_category 1 param body → 200

DELETE

/v1/group_categories/{group_category_id}

Delete a Group Category

delete_group_category 1 param → 200

POST

/v1/courses/{course_id}/group_categories/bulk_manage_differentiation_tag

Bulk manage differentiation tags

bulk_manage_differentiation_tags 1 param body → 200

GET

/v1/courses/{course_id}/group_categories/differentiation_tag_candidate_count

Get differentiation tag candidate count

get_differentiation_tag_candidate_count 4 params → 200

POST

/v1/courses/{course_id}/group_categories/import_tags

Import differentiation tags

import_differentiation_tags 1 param body → 200

POST

/v1/group_categories/{group_category_id}/import

Import category groups

import_category_groups 1 param body → 200

GET

/v1/group_categories/{group_category_id}/groups

List groups in group category

list_groups_in_group_category 1 param → 200

GET

/v1/group_categories/{group_category_id}/export

export groups in and users in category

export_groups_in_and_users_in_category 1 param → 200

GET

/v1/courses/{course_id}/group_categories/export_tags

export tags and users in course

export_tags_and_users_in_course 1 param → 200

GET

/v1/group_categories/{group_category_id}/users

List users in group category

list_users_in_group_category 3 params → 200

POST

/v1/group_categories/{group_category_id}/assign_unassigned_members

Assign unassigned members

assign_unassigned_members 1 param body → 200

History 1

GET

/v1/users/{user_id}/history

List recent history for a user

list_recent_history_for_user 1 param → 200

Inst Access Tokens 1

POST

/v1/inst_access_tokens

[DEPRECATED] Create InstAccess token

deprecated_create_instaccess_token → 200

Jw Ts 2

POST

/v1/jwts

Create JWT

create_jwt body → 200

POST

/v1/jwts/refresh

Refresh JWT

refresh_jwt body → 200

Late Policy 3

GET

/v1/courses/{id}/late_policy

Get a late policy

get_late_policy 1 param → 200

POST

/v1/courses/{id}/late_policy

Create a late policy

create_late_policy 1 param body → 200

PATCH

/v1/courses/{id}/late_policy

Patch a late policy

patch_late_policy 1 param body → 200

Learning Object Dates 11

GET

/v1/courses/{course_id}/modules/{context_module_id}/date_details

Get a learning object's date information

get_learning_object_s_date_information_modules 4 params → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/date_details

Get a learning object's date information

get_learning_object_s_date_information_assignments 4 params → 200

PUT

/v1/courses/{course_id}/assignments/{assignment_id}/date_details

Update a learning object's date information

update_learning_object_s_date_information_assignments 2 params body → 200

GET

/v1/courses/{course_id}/quizzes/{quiz_id}/date_details

Get a learning object's date information

get_learning_object_s_date_information_quizzes 4 params → 200

PUT

/v1/courses/{course_id}/quizzes/{quiz_id}/date_details

Update a learning object's date information

update_learning_object_s_date_information_quizzes 2 params body → 200

GET

/v1/courses/{course_id}/discussion_topics/{discussion_topic_id}/date_details

Get a learning object's date information

get_learning_object_s_date_information_discussion_topics 4 params → 200

PUT

/v1/courses/{course_id}/discussion_topics/{discussion_topic_id}/date_details

Update a learning object's date information

update_learning_object_s_date_information_discussion_topics 2 params body → 200

GET

/v1/courses/{course_id}/pages/{url_or_id}/date_details

Get a learning object's date information

get_learning_object_s_date_information_pages 4 params → 200

PUT

/v1/courses/{course_id}/pages/{url_or_id}/date_details

Update a learning object's date information

update_learning_object_s_date_information_pages 2 params body → 200

GET

/v1/courses/{course_id}/files/{attachment_id}/date_details

Get a learning object's date information

get_learning_object_s_date_information_files 4 params → 200

PUT

/v1/courses/{course_id}/files/{attachment_id}/date_details

Update a learning object's date information

update_learning_object_s_date_information_files 2 params body → 200

Line Items 5

POST

/lti/courses/{course_id}/line_items

Create a Line Item

create_line_item 1 param body → 200

GET

/lti/courses/{course_id}/line_items

List line Items

list_line_items 6 params → 200

PUT

/lti/courses/{course_id}/line_items/{id}

Update a Line Item

update_line_item 2 params body → 200

GET

/lti/courses/{course_id}/line_items/{id}

Show a Line Item

show_line_item 3 params → 200

DELETE

/lti/courses/{course_id}/line_items/{id}

Delete a Line Item

delete_line_item 2 params → 200

Live Assessments 4

POST

/v1/courses/{course_id}/live_assessments/{assessment_id}/results

Create live assessment results

create_live_assessment_results 2 params → 200

GET

/v1/courses/{course_id}/live_assessments/{assessment_id}/results

List live assessment results

list_live_assessment_results 3 params → 200

POST

/v1/courses/{course_id}/live_assessments

Create or find a live assessment

create_or_find_live_assessment 1 param → 200

GET

/v1/courses/{course_id}/live_assessments

List live assessments

list_live_assessments 1 param → 200

Logins 6

GET

/v1/accounts/{account_id}/logins

List user logins

list_user_logins_accounts 1 param → 200

POST

/v1/accounts/{account_id}/logins

Create a user login

create_user_login 1 param body → 200

GET

/v1/users/{user_id}/logins

List user logins

list_user_logins_users 1 param → 200

POST

/v1/users/reset_password

Kickoff password recovery flow

kickoff_password_recovery_flow → 200

PUT

/v1/accounts/{account_id}/logins/{id}

Edit a user login

edit_user_login 2 params body → 200

DELETE

/v1/users/{user_id}/logins/{id}

Delete a user login

delete_user_login 2 params → 200

Lti Context Controls 6

GET

/v1/accounts/{account_id}/lti_registrations/{registration_id}/controls

List All Context Controls

list_all_context_controls 2 params → 200

GET

/v1/accounts/{account_id}/lti_registrations/{registration_id}/controls/{id}

Show LTI Context Control

show_lti_context_control 3 params → 200

PUT

/v1/accounts/{account_id}/lti_registrations/{registration_id}/controls/{id}

Modify a Context Control

modify_context_control 3 params body → 200

DELETE

/v1/accounts/{account_id}/lti_registrations/{registration_id}/controls/{id}

Delete a Context Control

delete_context_control 3 params → 200

POST

/v1/accounts/{current_account_id}/lti_registrations/{registration_id}/controls

Create LTI Context Control

create_lti_context_control 2 params body → 200

POST

/v1/accounts/{account_id}/lti_registrations/{registration_id}/controls/bulk

Bulk Create LTI Context Controls

bulk_create_lti_context_controls 2 params body → 200

Lti Launch Definitions 2

GET

/v1/courses/{course_id}/lti_apps/launch_definitions

List LTI Launch Definitions

list_lti_launch_definitions_courses 4 params → 200

GET

/v1/accounts/{account_id}/lti_apps/launch_definitions

List LTI Launch Definitions

list_lti_launch_definitions_accounts 4 params → 200

Lti Registrations 36

GET

/v1/accounts/{account_id}/lti_registrations

List LTI Registrations in an account

list_lti_registrations_in_account_lti_registrations 6 params → 200

POST

/v1/accounts/{account_id}/lti_registrations

Create an LTI Registration

create_lti_registration_lti_registrations 1 param body → 200

GET

/v1/accounts/{account_id}/apps

List LTI Registrations in an account

list_lti_registrations_in_account_apps 6 params → 200

POST

/v1/accounts/{account_id}/apps

Create an LTI Registration

create_lti_registration_apps 1 param body → 200

GET

/v1/accounts/{account_id}/lti_registrations/{id}

Show an LTI Registration

show_lti_registration_lti_registrations 3 params → 200

PUT

/v1/accounts/{account_id}/lti_registrations/{id}

Update an LTI Registration

update_lti_registration_lti_registrations 2 params body → 200

DELETE

/v1/accounts/{account_id}/lti_registrations/{id}

Delete an LTI Registration

delete_lti_registration_lti_registrations 2 params → 200

GET

/v1/accounts/{account_id}/apps/{id}

Show an LTI Registration

show_lti_registration_apps 3 params → 200

PUT

/v1/accounts/{account_id}/apps/{id}

Update an LTI Registration

update_lti_registration_apps 2 params body → 200

DELETE

/v1/accounts/{account_id}/apps/{id}

Delete an LTI Registration

delete_lti_registration_apps 2 params → 200

GET

/v1/accounts/{account_id}/lti_registration_by_client_id/{client_id}

Show an LTI Registration (via the clientid)

show_lti_registration_via_client_id_lti_registration_by_client_id 2 params → 200

GET

/v1/accounts/{account_id}/app_by_client_id/{client_id}

Show an LTI Registration (via the clientid)

show_lti_registration_via_client_id_app_by_client_id 2 params → 200

GET

/v1/accounts/{account_id}/lti_registrations/by_utid/{utid}

Get LTI Registration by Unified Tool ID

get_lti_registration_by_unified_tool_id_lti_registrations 2 params → 200

GET

/v1/accounts/{account_id}/apps/by_utid/{utid}

Get LTI Registration by Unified Tool ID

get_lti_registration_by_unified_tool_id_apps 2 params → 200

GET

/v1/accounts/{account_id}/lti_registrations/install_status/{client_id}

Check LTI Registration Install Status

check_lti_registration_install_status_lti_registrations 2 params → 200

GET

/v1/accounts/{account_id}/apps/install_status/{client_id}

Check LTI Registration Install Status

check_lti_registration_install_status_apps 2 params → 200

PUT

/v1/accounts/{account_id}/lti_registrations/{id}/reset

Reset an LTI Registration to Defaults

reset_lti_registration_to_defaults_lti_registrations 2 params → 200

PUT

/v1/accounts/{account_id}/apps/{id}/reset

Reset an LTI Registration to Defaults

reset_lti_registration_to_defaults_apps 2 params → 200

POST

/v1/accounts/{account_id}/lti_registrations/{id}/bind

Bind an LTI Registration to a Root Account

bind_lti_registration_to_root_account_lti_registrations 2 params body → 200

DELETE

/v1/accounts/{account_id}/lti_registrations/{id}/bind

Remove an Inherited LTI Registration

remove_inherited_lti_registration_lti_registrations 2 params → 200

POST

/v1/accounts/{account_id}/apps/{id}/bind

Bind an LTI Registration to a Root Account

bind_lti_registration_to_root_account_apps 2 params body → 200

DELETE

/v1/accounts/{account_id}/apps/{id}/bind

Remove an Inherited LTI Registration

remove_inherited_lti_registration_apps 2 params → 200

POST

/v1/accounts/{account_id}/lti_registrations/{id}/install_from_template

Install an LTI Registration from a Template

install_lti_registration_from_template_lti_registrations 2 params → 200

POST

/v1/accounts/{account_id}/apps/{id}/install_from_template

Install an LTI Registration from a Template

install_lti_registration_from_template_apps 2 params → 200

GET

/v1/accounts/{account_id}/lti_registrations/{registration_id}/deployments/{deployment_id}/context_search

Search for Accounts and Courses

search_for_accounts_and_courses_lti_registrations 5 params → 200

GET

/v1/accounts/{account_id}/apps/{registration_id}/deployments/{deployment_id}/context_search

Search for Accounts and Courses

search_for_accounts_and_courses_apps 5 params → 200

GET

/v1/accounts/{account_id}/lti_registrations/{id}/overlay_history

Get LTI Registration Overlay History

get_lti_registration_overlay_history_lti_registrations 3 params → 200

GET

/v1/accounts/{account_id}/apps/{id}/overlay_history

Get LTI Registration Overlay History

get_lti_registration_overlay_history_apps 3 params → 200

GET

/v1/accounts/{account_id}/lti_registrations/{id}/history

Get LTI Registration History

get_lti_registration_history_lti_registrations 2 params → 200

GET

/v1/accounts/{account_id}/apps/{id}/history

Get LTI Registration History

get_lti_registration_history_apps 2 params → 200

GET

/v1/accounts/{account_id}/lti_registrations/{id}/update_requests/{update_request_id}

Get LTI Registration Update Request

get_lti_registration_update_request_lti_registrations 4 params → 200

GET

/v1/accounts/{account_id}/apps/{id}/update_requests/{update_request_id}

Get LTI Registration Update Request

get_lti_registration_update_request_apps 4 params → 200

GET

/v1/accounts/{account_id}/lti_registrations/{id}/latest_update_request

Get Latest LTI Registration Update Request

get_latest_lti_registration_update_request_lti_registrations 2 params → 200

GET

/v1/accounts/{account_id}/apps/{id}/latest_update_request

Get Latest LTI Registration Update Request

get_latest_lti_registration_update_request_apps 2 params → 200

PUT

/v1/accounts/{account_id}/lti_registrations/{id}/update_requests/{update_request_id}/apply

Apply LTI Registration Update Requst

apply_lti_registration_update_requst_lti_registrations 3 params body → 200

PUT

/v1/accounts/{account_id}/apps/{id}/update_requests/{update_request_id}/apply

Apply LTI Registration Update Requst

apply_lti_registration_update_requst_apps 3 params body → 200

Lti Resource Links 6

GET

/v1/courses/{course_id}/lti_resource_links

List LTI Resource Links

list_lti_resource_links 3 params → 200

POST

/v1/courses/{course_id}/lti_resource_links

Create an LTI Resource Link

create_lti_resource_link 1 param body → 200

GET

/v1/courses/{course_id}/lti_resource_links/{id}

Show an LTI Resource Link

show_lti_resource_link 3 params → 200

PUT

/v1/courses/{course_id}/lti_resource_links/{id}

Update an LTI Resource Link

update_lti_resource_link 2 params body → 200

DELETE

/v1/courses/{course_id}/lti_resource_links/{id}

Delete an LTI Resource Link

delete_lti_resource_link 2 params → 200

POST

/v1/courses/{course_id}/lti_resource_links/bulk

Bulk Create LTI Resource Links

bulk_create_lti_resource_links 1 param body → 200

Media Objects 12

GET

/v1/media_objects/{media_object_id}/media_tracks

List media tracks for a Media Object or Attachment

list_media_tracks_for_media_object_or_attachment_media_objects 2 params → 200

PUT

/v1/media_objects/{media_object_id}/media_tracks

Update Media Tracks

update_media_tracks_media_objects 1 param body → 200

GET

/v1/media_attachments/{attachment_id}/media_tracks

List media tracks for a Media Object or Attachment

list_media_tracks_for_media_object_or_attachment_media_attachments 2 params → 200

PUT

/v1/media_attachments/{attachment_id}/media_tracks

Update Media Tracks

update_media_tracks_media_attachments 1 param body → 200

GET

/v1/media_objects

List Media Objects

list_media_objects_media_objects 3 params → 200

GET

/v1/courses/{course_id}/media_objects

List Media Objects

list_media_objects_courses_media_objects 4 params → 200

GET

/v1/groups/{group_id}/media_objects

List Media Objects

list_media_objects_groups_media_objects 4 params → 200

GET

/v1/media_attachments

List Media Objects

list_media_objects_media_attachments 3 params → 200

GET

/v1/courses/{course_id}/media_attachments

List Media Objects

list_media_objects_courses_media_attachments 4 params → 200

GET

/v1/groups/{group_id}/media_attachments

List Media Objects

list_media_objects_groups_media_attachments 4 params → 200

PUT

/v1/media_objects/{media_object_id}

Update Media Object

update_media_object_media_objects 1 param body → 200

PUT

/v1/media_attachments/{attachment_id}

Update Media Object

update_media_object_media_attachments 1 param body → 200

Moderated Grading 8

GET

/v1/courses/{course_id}/assignments/{assignment_id}/moderated_students

List students selected for moderation

list_students_selected_for_moderation 2 params → 200

POST

/v1/courses/{course_id}/assignments/{assignment_id}/moderated_students

Select students for moderation

select_students_for_moderation 2 params body → 200

PUT

/v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/bulk_select

Bulk select provisional grades

bulk_select_provisional_grades 2 params → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/status

Show provisional grade status for a student

show_provisional_grade_status_for_student 3 params → 200

PUT

/v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/{provisional_grade_id}/select

Select provisional grade

select_provisional_grade 3 params → 200

POST

/v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/publishdeprecated

Publish provisional grades for an assignment

publish_provisional_grades_for_assignment 2 params → 200

POST

/v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/publish_async

Publish provisional grades for an assignment (asynchronous)

publish_provisional_grades_for_assignment_asynchronous 2 params → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/anonymous_provisional_grades/status

Show provisional grade status for a student

show_provisional_grade_status_for_student_moderated_grading 3 params → 200

Modules 17

GET

/v1/courses/{course_id}/modules

List modules

list_modules 4 params → 200

POST

/v1/courses/{course_id}/modules

Create a module

create_module 1 param body → 200

GET

/v1/courses/{course_id}/modules/{id}

Show module

show_module 4 params → 200

PUT

/v1/courses/{course_id}/modules/{id}

Update a module

update_module 2 params body → 200

DELETE

/v1/courses/{course_id}/modules/{id}

Delete module

delete_module 2 params → 200

PUT

/v1/courses/{course_id}/modules/{id}/relock

Re-lock module progressions

re_lock_module_progressions 2 params → 200

GET

/v1/courses/{course_id}/modules/{module_id}/items

List module items

list_module_items 5 params → 200

POST

/v1/courses/{course_id}/modules/{module_id}/items

Create a module item

create_module_item 2 params body → 200

GET

/v1/courses/{course_id}/modules/{module_id}/items/{id}

Show module item

show_module_item 5 params → 200

PUT

/v1/courses/{course_id}/modules/{module_id}/items/{id}

Update a module item

update_module_item 3 params body → 200

DELETE

/v1/courses/{course_id}/modules/{module_id}/items/{id}

Delete module item

delete_module_item 3 params → 200

POST

/v1/courses/{course_id}/modules/{module_id}/items/{id}/select_mastery_path

Select a mastery path

select_mastery_path 3 params body → 200

PUT

/v1/courses/{course_id}/modules/{module_id}/items/{id}/done

Mark module item as done/not done

mark_module_item_as_done_not_done 3 params → 200

GET

/v1/courses/{course_id}/module_item_sequence

Get module item sequence

get_module_item_sequence 3 params → 200

POST

/v1/courses/{course_id}/modules/{module_id}/items/{id}/mark_read

Mark module item read

mark_module_item_read 3 params → 200

GET

/v1/courses/{course_id}/modules/{context_module_id}/assignment_overrides

List a module's overrides

list_module_s_overrides 2 params → 200

PUT

/v1/courses/{course_id}/modules/{context_module_id}/assignment_overrides

Update a module's overrides

update_module_s_overrides 2 params body → 200

Names And Role 2

GET

/lti/courses/{course_id}/names_and_roles

List Course Memberships

list_course_memberships 4 params → 200

GET

/lti/groups/{group_id}/names_and_roles

List Group Memberships

list_group_memberships_names_and_role 4 params → 200

New Quiz Items 6

GET

/quiz/v1/courses/{course_id}/quizzes/{assignment_id}/items/{item_id}

Get a quiz item

get_quiz_item 3 params → 200

PATCH

/quiz/v1/courses/{course_id}/quizzes/{assignment_id}/items/{item_id}

Update a quiz item

update_quiz_item 3 params body → 200

DELETE

/quiz/v1/courses/{course_id}/quizzes/{assignment_id}/items/{item_id}

Delete a quiz item

delete_quiz_item 3 params → 200

GET

/quiz/v1/courses/{course_id}/quizzes/{assignment_id}/items

List quiz items

list_quiz_items 2 params → 200

POST

/quiz/v1/courses/{course_id}/quizzes/{assignment_id}/items

Create a quiz item

create_quiz_item 2 params body → 200

GET

/quiz/v1/courses/{course_id}/quizzes/{assignment_id}/items/media_upload_url

Get items mediauploadurl

get_items_media_upload_url 2 params → 200

New Quizzes 5

GET

/quiz/v1/courses/{course_id}/quizzes/{assignment_id}

Get a new quiz

get_new_quiz 2 params → 200

PATCH

/quiz/v1/courses/{course_id}/quizzes/{assignment_id}

Update a single quiz

update_single_quiz 2 params body → 200

DELETE

/quiz/v1/courses/{course_id}/quizzes/{assignment_id}

Delete a new quiz

delete_new_quiz 2 params → 200

GET

/quiz/v1/courses/{course_id}/quizzes

List new quizzes

list_new_quizzes 1 param → 200

POST

/quiz/v1/courses/{course_id}/quizzes

Create a new quiz

create_new_quiz 1 param body → 200

New Quizzes Accommodations 2

POST

/quiz/v1/courses/{course_id}/quizzes/{assignment_id}/accommodations

Set Quiz-Level Accommodations

set_quiz_level_accommodations 2 params body → 200

POST

/quiz/v1/courses/{course_id}/accommodations

Set Course-Level Accommodations

set_course_level_accommodations 1 param body → 200

New Quizzes Reports 1

POST

/quiz/v1/courses/{course_id}/quizzes/{assignment_id}/reports

Create a quiz report

create_quiz_report 2 params body → 200

Notice Handlers 2

GET

/lti/notice-handlers/{context_external_tool_id}

Show notice handlers

show_notice_handlers 1 param → 200

PUT

/lti/notice-handlers/{context_external_tool_id}

Set notice handler

set_notice_handler 1 param body → 200

Notification Preferences 10

GET

/v1/users/{user_id}/communication_channels/{communication_channel_id}/notification_preferences

List preferences

list_preferences_communication_channel_id 2 params → 200

GET

/v1/users/{user_id}/communication_channels/{type}/{address}/notification_preferences

List preferences

list_preferences_type 3 params → 200

GET

/v1/users/{user_id}/communication_channels/{communication_channel_id}/notification_preference_categories

List of preference categories

list_of_preference_categories 2 params → 200

GET

/v1/users/{user_id}/communication_channels/{communication_channel_id}/notification_preferences/{notification}

Get a preference

get_preference_communication_channel_id 3 params → 200

GET

/v1/users/{user_id}/communication_channels/{type}/{address}/notification_preferences/{notification}

Get a preference

get_preference_type 4 params → 200

PUT

/v1/users/self/communication_channels/{communication_channel_id}/notification_preferences/{notification}

Update a preference

update_preference_communication_channel_id 2 params body → 200

PUT

/v1/users/self/communication_channels/{type}/{address}/notification_preferences/{notification}

Update a preference

update_preference_type 3 params body → 200

PUT

/v1/users/self/communication_channels/{communication_channel_id}/notification_preference_categories/{category}

Update preferences by category

update_preferences_by_category 2 params body → 200

PUT

/v1/users/self/communication_channels/{communication_channel_id}/notification_preferences

Update multiple preferences

update_multiple_preferences_communication_channel_id 1 param body → 200

PUT

/v1/users/self/communication_channels/{type}/{address}/notification_preferences

Update multiple preferences

update_multiple_preferences_type 2 params body → 200

Originality Reports 5

POST

/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report

Create an Originality Report

create_originality_report 2 params body → 200

PUT

/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report/{id}

Edit an Originality Report

edit_originality_report_submissions 3 params body → 200

GET

/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report/{id}

Show an Originality Report

show_originality_report_submissions 3 params → 200

PUT

/lti/assignments/{assignment_id}/files/{file_id}/originality_report

Edit an Originality Report

edit_originality_report_files 2 params body → 200

GET

/lti/assignments/{assignment_id}/files/{file_id}/originality_report

Show an Originality Report

show_originality_report_files 2 params → 200

Outcome Groups 37

GET

/v1/global/root_outcome_group

Redirect to root outcome group for context

redirect_to_root_outcome_group_for_context_global → 200

GET

/v1/accounts/{account_id}/root_outcome_group

Redirect to root outcome group for context

redirect_to_root_outcome_group_for_context_accounts 1 param → 200

GET

/v1/courses/{course_id}/root_outcome_group

Redirect to root outcome group for context

redirect_to_root_outcome_group_for_context_courses 1 param → 200

GET

/v1/accounts/{account_id}/outcome_groups

Get all outcome groups for context

get_all_outcome_groups_for_context_accounts 1 param → 200

GET

/v1/courses/{course_id}/outcome_groups

Get all outcome groups for context

get_all_outcome_groups_for_context_courses 1 param → 200

GET

/v1/accounts/{account_id}/outcome_group_links

Get all outcome links for context

get_all_outcome_links_for_context_accounts 3 params → 200

GET

/v1/courses/{course_id}/outcome_group_links

Get all outcome links for context

get_all_outcome_links_for_context_courses 3 params → 200

GET

/v1/global/outcome_groups/{id}

Show an outcome group

show_outcome_group_global 1 param → 200

PUT

/v1/global/outcome_groups/{id}

Update an outcome group

update_outcome_group_global 1 param body → 200

DELETE

/v1/global/outcome_groups/{id}

Delete an outcome group

delete_outcome_group_global 1 param → 200

GET

/v1/accounts/{account_id}/outcome_groups/{id}

Show an outcome group

show_outcome_group_accounts 2 params → 200

PUT

/v1/accounts/{account_id}/outcome_groups/{id}

Update an outcome group

update_outcome_group_accounts 2 params body → 200

DELETE

/v1/accounts/{account_id}/outcome_groups/{id}

Delete an outcome group

delete_outcome_group_accounts 2 params → 200

GET

/v1/courses/{course_id}/outcome_groups/{id}

Show an outcome group

show_outcome_group_courses 2 params → 200

PUT

/v1/courses/{course_id}/outcome_groups/{id}

Update an outcome group

update_outcome_group_courses 2 params body → 200

DELETE

/v1/courses/{course_id}/outcome_groups/{id}

Delete an outcome group

delete_outcome_group_courses 2 params → 200

GET

/v1/global/outcome_groups/{id}/outcomes

List linked outcomes

list_linked_outcomes_global 2 params → 200

POST

/v1/global/outcome_groups/{id}/outcomes

Create/link an outcome

create_link_outcome_global 1 param body → 200

GET

/v1/accounts/{account_id}/outcome_groups/{id}/outcomes

List linked outcomes

list_linked_outcomes_accounts 3 params → 200

POST

/v1/accounts/{account_id}/outcome_groups/{id}/outcomes

Create/link an outcome

create_link_outcome_accounts 2 params body → 200

GET

/v1/courses/{course_id}/outcome_groups/{id}/outcomes

List linked outcomes

list_linked_outcomes_courses 3 params → 200

POST

/v1/courses/{course_id}/outcome_groups/{id}/outcomes

Create/link an outcome

create_link_outcome_courses 2 params body → 200

PUT

/v1/global/outcome_groups/{id}/outcomes/{outcome_id}

Create/link an outcome

create_link_outcome_global_outcome_id 2 params body → 200

DELETE

/v1/global/outcome_groups/{id}/outcomes/{outcome_id}

Unlink an outcome

unlink_outcome_global 2 params → 200

PUT

/v1/accounts/{account_id}/outcome_groups/{id}/outcomes/{outcome_id}

Create/link an outcome

create_link_outcome_accounts_outcome_id 3 params body → 200

DELETE

/v1/accounts/{account_id}/outcome_groups/{id}/outcomes/{outcome_id}

Unlink an outcome

unlink_outcome_accounts 3 params → 200

PUT

/v1/courses/{course_id}/outcome_groups/{id}/outcomes/{outcome_id}

Create/link an outcome

create_link_outcome_courses_outcome_id 3 params body → 200

DELETE

/v1/courses/{course_id}/outcome_groups/{id}/outcomes/{outcome_id}

Unlink an outcome

unlink_outcome_courses 3 params → 200

GET

/v1/global/outcome_groups/{id}/subgroups

List subgroups

list_subgroups_global 1 param → 200

POST

/v1/global/outcome_groups/{id}/subgroups

Create a subgroup

create_subgroup_global 1 param body → 200

GET

/v1/accounts/{account_id}/outcome_groups/{id}/subgroups

List subgroups

list_subgroups_accounts 2 params → 200

POST

/v1/accounts/{account_id}/outcome_groups/{id}/subgroups

Create a subgroup

create_subgroup_accounts 2 params body → 200

GET

/v1/courses/{course_id}/outcome_groups/{id}/subgroups

List subgroups

list_subgroups_courses 2 params → 200

POST

/v1/courses/{course_id}/outcome_groups/{id}/subgroups

Create a subgroup

create_subgroup_courses 2 params body → 200

POST

/v1/global/outcome_groups/{id}/import

Import an outcome group

import_outcome_group_global 1 param body → 200

POST

/v1/accounts/{account_id}/outcome_groups/{id}/import

Import an outcome group

import_outcome_group_accounts 2 params body → 200

POST

/v1/courses/{course_id}/outcome_groups/{id}/import

Import an outcome group

import_outcome_group_courses 2 params body → 200

Outcome Imports 6

POST

/v1/accounts/{account_id}/outcome_imports

Import Outcomes

import_outcomes_accounts 1 param body → 200

POST

/v1/courses/{course_id}/outcome_imports

Import Outcomes

import_outcomes_courses 1 param body → 200

GET

/v1/accounts/{account_id}/outcome_imports/{id}

Get Outcome import status

get_outcome_import_status_accounts 2 params → 200

GET

/v1/courses/{course_id}/outcome_imports/{id}

Get Outcome import status

get_outcome_import_status_courses 2 params → 200

GET

/v1/accounts/{account_id}/outcome_imports/{id}/created_group_ids

Get IDs of outcome groups created after successful import

get_ids_of_outcome_groups_created_after_successful_import_accounts 2 params → 200

GET

/v1/courses/{course_id}/outcome_imports/{id}/created_group_ids

Get IDs of outcome groups created after successful import

get_ids_of_outcome_groups_created_after_successful_import_courses 2 params → 200

Outcome Results 6

GET

/v1/courses/{course_id}/outcome_results

Get outcome results

get_outcome_results 5 params → 200

POST

/v1/courses/{course_id}/assign_outcome_order

Set outcome ordering for LMGB

set_outcome_ordering_for_lmgb 1 param → 200

GET

/v1/courses/{course_id}/outcome_rollups

Get outcome result rollups

get_outcome_result_rollups 12 params → 200

GET

/v1/courses/{course_id}/outcomes/{outcome_id}/contributing_scores

Get contributing scores

get_contributing_scores 5 params → 200

GET

/v1/courses/{course_id}/outcome_mastery_distribution

Get mastery distribution

get_mastery_distribution 8 params → 200

POST

/v1/courses/{course_id}/enqueue_outcome_rollup_calculation

Enqueue a delayed Outcome Rollup Calculation Job

enqueue_delayed_outcome_rollup_calculation_job 1 param body → 200

Outcomes 3

GET

/v1/outcomes/{id}

Show an outcome

show_outcome 2 params → 200

PUT

/v1/outcomes/{id}

Update an outcome

update_outcome 1 param body → 200

GET

/v1/courses/{course_id}/outcome_alignments

Get outcome alignments for a student or assignment

get_outcome_alignments_for_student_or_assignment 3 params → 200

Pages 23

GET

/v1/courses/{course_id}/front_page

Show front page

show_front_page_courses 1 param → 200

PUT

/v1/courses/{course_id}/front_page

Update/create front page

update_create_front_page_courses 1 param body → 200

GET

/v1/groups/{group_id}/front_page

Show front page

show_front_page_groups 1 param → 200

PUT

/v1/groups/{group_id}/front_page

Update/create front page

update_create_front_page_groups 1 param body → 200

POST

/v1/courses/{course_id}/pages/{url_or_id}/duplicate

Duplicate page

duplicate_page 2 params → 200

GET

/v1/courses/{course_id}/pages

List pages

list_pages_courses 6 params → 200

POST

/v1/courses/{course_id}/pages

Create page

create_page_courses 1 param body → 200

GET

/v1/groups/{group_id}/pages

List pages

list_pages_groups 6 params → 200

POST

/v1/groups/{group_id}/pages

Create page

create_page_groups 1 param body → 200

GET

/v1/courses/{course_id}/pages/{url_or_id}

Show page

show_page_courses 2 params → 200

PUT

/v1/courses/{course_id}/pages/{url_or_id}

Update/create page

update_create_page_courses 2 params body → 200

DELETE

/v1/courses/{course_id}/pages/{url_or_id}

Delete page

delete_page_courses 2 params → 200

GET

/v1/groups/{group_id}/pages/{url_or_id}

Show page

show_page_groups 2 params → 200

PUT

/v1/groups/{group_id}/pages/{url_or_id}

Update/create page

update_create_page_groups 2 params body → 200

DELETE

/v1/groups/{group_id}/pages/{url_or_id}

Delete page

delete_page_groups 2 params → 200

GET

/v1/courses/{course_id}/pages/{url_or_id}/revisions

List revisions

list_revisions_courses 2 params → 200

GET

/v1/groups/{group_id}/pages/{url_or_id}/revisions

List revisions

list_revisions_groups 2 params → 200

GET

/v1/courses/{course_id}/pages/{url_or_id}/revisions/latest

Show revision

show_revision_courses_latest 3 params → 200

GET

/v1/groups/{group_id}/pages/{url_or_id}/revisions/latest

Show revision

show_revision_groups_latest 3 params → 200

GET

/v1/courses/{course_id}/pages/{url_or_id}/revisions/{revision_id}

Show revision

show_revision_courses_revision_id 4 params → 200

POST

/v1/courses/{course_id}/pages/{url_or_id}/revisions/{revision_id}

Revert to revision

revert_to_revision_courses 3 params → 200

GET

/v1/groups/{group_id}/pages/{url_or_id}/revisions/{revision_id}

Show revision

show_revision_groups_revision_id 4 params → 200

POST

/v1/groups/{group_id}/pages/{url_or_id}/revisions/{revision_id}

Revert to revision

revert_to_revision_groups 3 params → 200

Peer Reviews 9

GET

/v1/courses/{course_id}/assignments/{assignment_id}/peer_reviews

Get all Peer Reviews

get_all_peer_reviews_courses_peer_reviews 3 params → 200

GET

/v1/sections/{section_id}/assignments/{assignment_id}/peer_reviews

Get all Peer Reviews

get_all_peer_reviews_sections_peer_reviews 3 params → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews

Get all Peer Reviews

get_all_peer_reviews_courses_submissions 4 params → 200

POST

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews

Create Peer Review

create_peer_review_courses 3 params body → 200

DELETE

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews

Delete Peer Review

delete_peer_review_courses 4 params → 200

GET

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews

Get all Peer Reviews

get_all_peer_reviews_sections_submissions 4 params → 200

POST

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews

Create Peer Review

create_peer_review_sections 3 params body → 200

DELETE

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews

Delete Peer Review

delete_peer_review_sections 4 params → 200

POST

/v1/courses/{course_id}/assignments/{assignment_id}/allocate

Allocate Peer Review

allocate_peer_review 2 params → 200

Plagiarism Detection Platform Assignments 1

GET

/lti/assignments/{assignment_id}

Get a single assignment (lti)

get_single_assignment_lti 2 params → 200

Plagiarism Detection Platform Users 2

GET

/lti/users/{id}

Get a single user (lti)

get_single_user_lti 1 param → 200

GET

/lti/groups/{group_id}/users

Get all users in a group (lti)

get_all_users_in_group_lti 1 param → 200

Plagiarism Detection Submissions 2

GET

/lti/assignments/{assignment_id}/submissions/{submission_id}

Get a single submission

get_single_submission 2 params → 200

GET

/lti/assignments/{assignment_id}/submissions/{submission_id}/history

Get the history of a single submission

get_history_of_single_submission 2 params → 200

Planner 12

GET

/v1/planner/items

List planner items

list_planner_items_planner 7 params → 200

GET

/v1/users/{user_id}/planner/items

List planner items

list_planner_items_users 8 params → 200

GET

/v1/planner_notes

List planner notes

list_planner_notes 3 params → 200

POST

/v1/planner_notes

Create a planner note

create_planner_note body → 200

GET

/v1/planner_notes/{id}

Show a planner note

show_planner_note 1 param → 200

PUT

/v1/planner_notes/{id}

Update a planner note

update_planner_note 1 param body → 200

DELETE

/v1/planner_notes/{id}

Delete a planner note

delete_planner_note 1 param → 200

GET

/v1/planner/overrides

List planner overrides

list_planner_overrides → 200

POST

/v1/planner/overrides

Create a planner override

create_planner_override body → 200

GET

/v1/planner/overrides/{id}

Show a planner override

show_planner_override 1 param → 200

PUT

/v1/planner/overrides/{id}

Update a planner override

update_planner_override 1 param body → 200

DELETE

/v1/planner/overrides/{id}

Delete a planner override

delete_planner_override 1 param → 200

Poll Choices 5

GET

/v1/polls/{poll_id}/poll_choices

List poll choices in a poll

list_poll_choices_in_poll 1 param → 200

POST

/v1/polls/{poll_id}/poll_choices

Create a single poll choice

create_single_poll_choice 1 param body → 200

GET

/v1/polls/{poll_id}/poll_choices/{id}

Get a single poll choice

get_single_poll_choice 2 params → 200

PUT

/v1/polls/{poll_id}/poll_choices/{id}

Update a single poll choice

update_single_poll_choice 2 params body → 200

DELETE

/v1/polls/{poll_id}/poll_choices/{id}

Delete a poll choice

delete_poll_choice 2 params → 200

Poll Sessions 9

GET

/v1/polls/{poll_id}/poll_sessions

List poll sessions for a poll

list_poll_sessions_for_poll 1 param → 200

POST

/v1/polls/{poll_id}/poll_sessions

Create a single poll session

create_single_poll_session 1 param body → 200

GET

/v1/polls/{poll_id}/poll_sessions/{id}

Get the results for a single poll session

get_results_for_single_poll_session 2 params → 200

PUT

/v1/polls/{poll_id}/poll_sessions/{id}

Update a single poll session

update_single_poll_session 2 params body → 200

DELETE

/v1/polls/{poll_id}/poll_sessions/{id}

Delete a poll session

delete_poll_session 2 params → 200

GET

/v1/polls/{poll_id}/poll_sessions/{id}/open

Open a poll session

open_poll_session 2 params → 200

GET

/v1/polls/{poll_id}/poll_sessions/{id}/close

Close an opened poll session

close_opened_poll_session 2 params → 200

GET

/v1/poll_sessions/opened

List opened poll sessions

list_opened_poll_sessions → 200

GET

/v1/poll_sessions/closed

List closed poll sessions

list_closed_poll_sessions → 200

Poll Submissions 2

GET

/v1/polls/{poll_id}/poll_sessions/{poll_session_id}/poll_submissions/{id}

Get a single poll submission

get_single_poll_submission 3 params → 200

POST

/v1/polls/{poll_id}/poll_sessions/{poll_session_id}/poll_submissions

Create a single poll submission

create_single_poll_submission 2 params body → 200

Polls 5

GET

/v1/polls

List polls

list_polls → 200

POST

/v1/polls

Create a single poll

create_single_poll body → 200

GET

/v1/polls/{id}

Get a single poll

get_single_poll 1 param → 200

PUT

/v1/polls/{id}

Update a single poll

update_single_poll 1 param body → 200

DELETE

/v1/polls/{id}

Delete a poll

delete_poll 1 param → 200

Portfolio Notifications 1

POST

/v1/users/{user_id}/portfolio_notifications

Create a portfolio notification

create_portfolio_notification 1 param body → 200

Proficiency Ratings 4

POST

/v1/accounts/{account_id}/outcome_proficiency

Create/update proficiency ratings

create_update_proficiency_ratings_accounts 1 param body → 200

GET

/v1/accounts/{account_id}/outcome_proficiency

Get proficiency ratings

get_proficiency_ratings_accounts 1 param → 200

POST

/v1/courses/{course_id}/outcome_proficiency

Create/update proficiency ratings

create_update_proficiency_ratings_courses 1 param body → 200

GET

/v1/courses/{course_id}/outcome_proficiency

Get proficiency ratings

get_proficiency_ratings_courses 1 param → 200

Progress 3

GET

/v1/progress/{id}

Query progress

query_progress 1 param → 200

POST

/v1/progress/{id}/cancel

Cancel progress

cancel_progress 1 param → 200

GET

/lti/courses/{course_id}/progress/{id}

Query progress

query_progress_progress 2 params → 200

Public Jwk 1

PUT

/lti/developer_key/update_public_jwk

Update Public JWK

update_public_jwk body → 200

Quiz Assignment Overrides 2

GET

/v1/courses/{course_id}/quizzes/assignment_overrides

Retrieve assignment-overridden dates for Classic Quizzes

retrieve_assignment_overridden_dates_for_classic_quizzes 2 params → 200

GET

/v1/courses/{course_id}/new_quizzes/assignment_overrides

Retrieve assignment-overridden dates for New Quizzes

retrieve_assignment_overridden_dates_for_new_quizzes 2 params → 200

Quiz Extensions 1

POST

/v1/courses/{course_id}/quizzes/{quiz_id}/extensions

Set extensions for student quiz submissions

set_extensions_for_student_quiz_submissions_quiz_extensions 2 params body → 200

Quiz Ip Filters 1

GET

/v1/courses/{course_id}/quizzes/{quiz_id}/ip_filters

Get available quiz IP filters.

get_available_quiz_ip_filters 2 params → 200

Quiz Question Groups 6

GET

/v1/courses/{course_id}/quizzes/{quiz_id}/groups

List question groups in a quiz

list_question_groups_in_quiz 2 params → 200

POST

/v1/courses/{course_id}/quizzes/{quiz_id}/groups

Create a question group

create_question_group 2 params body → 200

GET

/v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}

Get a single quiz group

get_single_quiz_group 3 params → 200

PUT

/v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}

Update a question group

update_question_group 3 params body → 200

DELETE

/v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}

Delete a question group

delete_question_group 3 params → 200

POST

/v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}/reorder

Reorder question groups

reorder_question_groups 3 params body → 200

Quiz Questions 5

GET

/v1/courses/{course_id}/quizzes/{quiz_id}/questions

List questions in a quiz or a submission

list_questions_in_quiz_or_submission 4 params → 200

POST

/v1/courses/{course_id}/quizzes/{quiz_id}/questions

Create a single quiz question

create_single_quiz_question 2 params body → 200

GET

/v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id}

Get a single quiz question

get_single_quiz_question 3 params → 200

PUT

/v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id}

Update an existing quiz question

update_existing_quiz_question 3 params body → 200

DELETE

/v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id}

Delete a quiz question

delete_quiz_question 3 params → 200

Quiz Reports 4

GET

/v1/courses/{course_id}/quizzes/{quiz_id}/reports

Retrieve all quiz reports

retrieve_all_quiz_reports 3 params → 200

POST

/v1/courses/{course_id}/quizzes/{quiz_id}/reports

Create a quiz report

create_quiz_report_quiz_reports 2 params body → 200

GET

/v1/courses/{course_id}/quizzes/{quiz_id}/reports/{id}

Get a quiz report

get_quiz_report 4 params → 200

DELETE

/v1/courses/{course_id}/quizzes/{quiz_id}/reports/{id}

Abort the generation of a report, or remove a previously generated one

abort_generation_of_report_or_remove_previously_generated_one 3 params → 200

Quiz Statistics 1

GET

/v1/courses/{course_id}/quizzes/{quiz_id}/statistics

Fetching the latest quiz statistics

fetching_latest_quiz_statistics 3 params → 200

Quiz Submission Events 2

POST

/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/events

Submit captured events

submit_captured_events 3 params body → 200

GET

/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/events

Retrieve captured events

retrieve_captured_events 4 params → 200

Quiz Submission Files 1

POST

/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/self/files

Upload a file

upload_file_quiz_submission_files 2 params body → 200

Quiz Submission Questions 5

GET

/v1/quiz_submissions/{quiz_submission_id}/questions

Get all quiz submission questions.

get_all_quiz_submission_questions 2 params → 200

POST

/v1/quiz_submissions/{quiz_submission_id}/questions

Answering questions

answering_questions 1 param body → 200

GET

/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/formatted_answer

Get a formatted student numerical answer.

get_formatted_student_numerical_answer 3 params → 200

PUT

/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/flag

Flagging a question.

flagging_question 2 params body → 200

PUT

/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/unflag

Unflagging a question.

unflagging_question 2 params body → 200

Quiz Submission User List 1

POST

/v1/courses/{course_id}/quizzes/{id}/submission_users/message

Send a message to unsubmitted or submitted users for the quiz

send_message_to_unsubmitted_or_submitted_users_for_quiz 2 params body → 200

Quiz Submissions 7

GET

/v1/courses/{course_id}/quizzes/{quiz_id}/submissions

Get all quiz submissions.

get_all_quiz_submissions 3 params → 200

POST

/v1/courses/{course_id}/quizzes/{quiz_id}/submissions

Create the quiz submission (start a quiz-taking session)

create_quiz_submission_start_quiz_taking_session 2 params body → 200

GET

/v1/courses/{course_id}/quizzes/{quiz_id}/submission

Get the quiz submission.

get_quiz_submission 3 params → 200

GET

/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}

Get a single quiz submission.

get_single_quiz_submission 4 params → 200

PUT

/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}

Update student question scores and comments.

update_student_question_scores_and_comments 3 params body → 200

POST

/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/complete

Complete the quiz submission (turn it in).

complete_quiz_submission_turn_it_in 3 params body → 200

GET

/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/time

Get current quiz submission times.

get_current_quiz_submission_times 3 params → 200

Quizzes 7

GET

/v1/courses/{course_id}/quizzes

List quizzes in a course

list_quizzes_in_course 2 params → 200

POST

/v1/courses/{course_id}/quizzes

Create a quiz

create_quiz 1 param body → 200

GET

/v1/courses/{course_id}/quizzes/{id}

Get a single quiz

get_single_quiz 2 params → 200

PUT

/v1/courses/{course_id}/quizzes/{id}

Edit a quiz

edit_quiz 2 params body → 200

DELETE

/v1/courses/{course_id}/quizzes/{id}

Delete a quiz

delete_quiz 2 params → 200

POST

/v1/courses/{course_id}/quizzes/{id}/reorder

Reorder quiz items

reorder_quiz_items 2 params body → 200

POST

/v1/courses/{course_id}/quizzes/{id}/validate_access_code

Validate quiz access code

validate_quiz_access_code 2 params body → 200

Result 2

GET

/lti/courses/{course_id}/line_items/{line_item_id}/results

Show a collection of Results

show_collection_of_results 2 params → 200

GET

/lti/courses/{course_id}/line_items/{line_item_id}/results/{id}

Show a Result

show_result 3 params → 200

Roles 9

GET

/v1/accounts/{account_id}/roles

List roles

list_roles 3 params → 200

POST

/v1/accounts/{account_id}/roles

Create a new role

create_new_role 1 param body → 200

GET

/v1/accounts/{account_id}/roles/{id}

Get a single role

get_single_role 4 params → 200

DELETE

/v1/accounts/{account_id}/roles/{id}

Deactivate a role

deactivate_role 4 params → 200

PUT

/v1/accounts/{account_id}/roles/{id}

Update a role

update_role 2 params body → 200

POST

/v1/accounts/{account_id}/roles/{id}/activate

Activate a role

activate_role 2 params body → 200

GET

/v1/accounts/{account_id}/roles/permissions

List assignable permissions

list_assignable_permissions 2 params → 200

GET

/v1/permissions/{context_type}/{permission}/help

Get help text for permissions

get_help_text_for_permissions 2 params → 200

GET

/v1/permissions/groups

Retrieve permission groups

retrieve_permission_groups → 200

Rubrics 20

POST

/v1/courses/{course_id}/rubrics

Create a single rubric

create_single_rubric 1 param body → 200

GET

/v1/courses/{course_id}/rubrics

List rubrics

list_rubrics_courses 1 param → 200

PUT

/v1/courses/{course_id}/rubrics/{id}

Update a single rubric

update_single_rubric 2 params body → 200

DELETE

/v1/courses/{course_id}/rubrics/{id}

Delete a single

delete_single 2 params → 200

GET

/v1/courses/{course_id}/rubrics/{id}

Get a single rubric

get_single_rubric_courses 4 params → 200

GET

/v1/accounts/{account_id}/rubrics

List rubrics

list_rubrics_accounts 1 param → 200

GET

/v1/accounts/{account_id}/rubrics/{id}

Get a single rubric

get_single_rubric_accounts 4 params → 200

GET

/v1/courses/{course_id}/rubrics/{id}/used_locations

Get the courses and assignments for a rubric

get_courses_and_assignments_for_rubric_courses 2 params → 200

GET

/v1/accounts/{account_id}/rubrics/{id}/used_locations

Get the courses and assignments for a rubric

get_courses_and_assignments_for_rubric_accounts 2 params → 200

POST

/v1/courses/{course_id}/rubrics/upload

Creates a rubric using a CSV file

creates_rubric_using_csv_file_courses 1 param → 200

POST

/v1/accounts/{account_id}/rubrics/upload

Creates a rubric using a CSV file

creates_rubric_using_csv_file_accounts 1 param → 200

GET

/v1/rubrics/upload_template

Templated file for importing a rubric

templated_file_for_importing_rubric → 200

GET

/v1/courses/{course_id}/rubrics/upload/{id}

Get the status of a rubric import

get_status_of_rubric_import_courses 2 params → 200

GET

/v1/accounts/{account_id}/rubrics/upload/{id}

Get the status of a rubric import

get_status_of_rubric_import_accounts 2 params → 200

POST

/v1/courses/{course_id}/rubric_associations/{rubric_association_id}/rubric_assessments

Create a single rubric assessment

create_single_rubric_assessment 2 params body → 200

PUT

/v1/courses/{course_id}/rubric_associations/{rubric_association_id}/rubric_assessments/{id}

Update a single rubric assessment

update_single_rubric_assessment 3 params body → 200

DELETE

/v1/courses/{course_id}/rubric_associations/{rubric_association_id}/rubric_assessments/{id}

Delete a single rubric assessment

delete_single_rubric_assessment 3 params → 200

POST

/v1/courses/{course_id}/rubric_associations

Create a RubricAssociation

create_rubricassociation 1 param body → 200

PUT

/v1/courses/{course_id}/rubric_associations/{id}

Update a RubricAssociation

update_rubricassociation 2 params body → 200

DELETE

/v1/courses/{course_id}/rubric_associations/{id}

Delete a RubricAssociation

delete_rubricassociation 2 params → 200

Sandboxes 1

GET

/lti/uuid_map

Download UUID Mapping for this Sandbox

download_uuid_mapping_for_this_sandbox → 200

Score 1

POST

/lti/courses/{course_id}/line_items/{line_item_id}/scores

Create a Score

create_score 2 params body → 200

Sections 9

GET

/v1/courses/{course_id}/sections

List course sections

list_course_sections 3 params → 200

POST

/v1/courses/{course_id}/sections

Create course section

create_course_section 1 param body → 200

POST

/v1/sections/{id}/crosslist/{new_course_id}

Cross-list a Section

cross_list_section 2 params body → 200

DELETE

/v1/sections/{id}/crosslist

De-cross-list a Section

de_cross_list_section 2 params → 200

PUT

/v1/sections/{id}

Edit a section

edit_section 1 param body → 200

GET

/v1/sections/{id}

Get section information

get_section_information_sections 2 params → 200

DELETE

/v1/sections/{id}

Delete a section

delete_section 1 param → 200

GET

/v1/courses/{course_id}/sections/{id}

Get section information

get_section_information_courses 3 params → 200

GET

/v1/sections/{id}/users

List section's users

list_section_s_users 5 params → 200

Services 2

GET

/v1/services/kaltura

Get Kaltura config

get_kaltura_config → 200

POST

/v1/services/kaltura_session

Start Kaltura session

start_kaltura_session → 200

Shared Brand Configs 3

POST

/v1/accounts/{account_id}/shared_brand_configs

Share a BrandConfig (Theme)

share_brandconfig_theme 1 param body → 200

PUT

/v1/accounts/{account_id}/shared_brand_configs/{id}

Update a shared theme

update_shared_theme 2 params → 200

DELETE

/v1/shared_brand_configs/{id}

Un-share a BrandConfig (Theme)

un_share_brandconfig_theme 1 param → 200

Sis Import Errors 2

GET

/v1/accounts/{account_id}/sis_imports/{id}/errors

Get SIS import error list

get_sis_import_error_list_sis_imports 3 params → 200

GET

/v1/accounts/{account_id}/sis_import_errors

Get SIS import error list

get_sis_import_error_list_sis_import_errors 2 params → 200

Sis Imports 7

GET

/v1/accounts/{account_id}/sis_imports

Get SIS import list

get_sis_import_list 4 params → 200

POST

/v1/accounts/{account_id}/sis_imports

Import SIS data

import_sis_data 1 param body → 200

GET

/v1/accounts/{account_id}/sis_imports/importing

Get the current importing SIS import

get_current_importing_sis_import 1 param → 200

GET

/v1/accounts/{account_id}/sis_imports/{id}

Get SIS import status

get_sis_import_status 2 params → 200

PUT

/v1/accounts/{account_id}/sis_imports/{id}/restore_states

Restore workflowstates of SIS imported items

restore_workflow_states_of_sis_imported_items 2 params body → 200

PUT

/v1/accounts/{account_id}/sis_imports/{id}/abort

Abort SIS import

abort_sis_import 2 params → 200

PUT

/v1/accounts/{account_id}/sis_imports/abort_all_pending

Abort all pending SIS imports

abort_all_pending_sis_imports 1 param → 200

Sis Integration 3

GET

/sis/accounts/{account_id}/assignments

Retrieve assignments enabled for grade export to SIS

retrieve_assignments_enabled_for_grade_export_to_sis_accounts 5 params → 200

GET

/sis/courses/{course_id}/assignments

Retrieve assignments enabled for grade export to SIS

retrieve_assignments_enabled_for_grade_export_to_sis_courses 5 params → 200

PUT

/sis/courses/{course_id}/disable_post_to_sis

Disable assignments currently enabled for grade export to SIS

disable_assignments_currently_enabled_for_grade_export_to_sis 1 param body → 200

Smart Search 1

GET

/v1/courses/{course_id}/smartsearch

Search course content

search_course_content 4 params → 200

Study Assist 1

POST

/v1/courses/{course_id}/study_assist

Request a study assist response

request_study_assist_response 1 param body → 200

Submission Comments 4

PUT

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/{id}

Edit a submission comment

edit_submission_comment 4 params body → 200

DELETE

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/{id}

Delete a submission comment

delete_submission_comment 4 params → 200

POST

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/files

Upload a file

upload_file_submission_comments 3 params → 200

POST

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/annotation_notification

Send annotation notification

send_annotation_notification 3 params body → 200

Submissions 46

POST

/v1/courses/{course_id}/assignments/{assignment_id}/submissions

Submit an assignment

submit_assignment_courses 2 params body → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/submissions

List assignment submissions

list_assignment_submissions_courses 4 params → 200

POST

/v1/sections/{section_id}/assignments/{assignment_id}/submissions

Submit an assignment

submit_assignment_sections 2 params body → 200

GET

/v1/sections/{section_id}/assignments/{assignment_id}/submissions

List assignment submissions

list_assignment_submissions_sections 4 params → 200

GET

/v1/courses/{course_id}/students/submissions

List submissions for multiple assignments

list_submissions_for_multiple_assignments_courses 14 params → 200

GET

/v1/sections/{section_id}/students/submissions

List submissions for multiple assignments

list_submissions_for_multiple_assignments_sections 14 params → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}

Get a single submission

get_single_submission_courses 4 params → 200

PUT

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}

Grade or comment on a submission

grade_or_comment_on_submission_courses 3 params body → 200

GET

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}

Get a single submission

get_single_submission_sections 4 params → 200

PUT

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}

Grade or comment on a submission

grade_or_comment_on_submission_sections 3 params body → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/anonymous_submissions/{anonymous_id}

Get a single submission by anonymous id

get_single_submission_by_anonymous_id_courses 4 params → 200

PUT

/v1/courses/{course_id}/assignments/{assignment_id}/anonymous_submissions/{anonymous_id}

Grade or comment on a submission by anonymous id

grade_or_comment_on_submission_by_anonymous_id_courses 3 params body → 200

GET

/v1/sections/{section_id}/assignments/{assignment_id}/anonymous_submissions/{anonymous_id}

Get a single submission by anonymous id

get_single_submission_by_anonymous_id_sections 4 params → 200

PUT

/v1/sections/{section_id}/assignments/{assignment_id}/anonymous_submissions/{anonymous_id}

Grade or comment on a submission by anonymous id

grade_or_comment_on_submission_by_anonymous_id_sections 3 params body → 200

POST

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/files

Upload a file

upload_file_courses 3 params → 200

POST

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/files

Upload a file

upload_file_sections 3 params → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/gradeable_students

List gradeable students

list_gradeable_students 4 params → 200

GET

/v1/courses/{course_id}/assignments/gradeable_students

List multiple assignments gradeable students

list_multiple_assignments_gradeable_students 2 params → 200

POST

/v1/courses/{course_id}/submissions/update_grades

Grade or comment on multiple submissions

grade_or_comment_on_multiple_submissions_courses_submissions 1 param body → 200

POST

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/update_grades

Grade or comment on multiple submissions

grade_or_comment_on_multiple_submissions_courses_assignments 2 params body → 200

POST

/v1/sections/{section_id}/submissions/update_grades

Grade or comment on multiple submissions

grade_or_comment_on_multiple_submissions_sections_submissions 1 param body → 200

POST

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/update_grades

Grade or comment on multiple submissions

grade_or_comment_on_multiple_submissions_sections_assignments 2 params body → 200

PUT

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/read

Mark submission as read

mark_submission_as_read_courses 3 params → 200

DELETE

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/read

Mark submission as unread

mark_submission_as_unread_courses 3 params → 200

PUT

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/read

Mark submission as read

mark_submission_as_read_sections 3 params → 200

DELETE

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/read

Mark submission as unread

mark_submission_as_unread_sections 3 params → 200

PUT

/v1/courses/{course_id}/submissions/bulk_mark_read

Mark bulk submissions as read

mark_bulk_submissions_as_read_courses 1 param body → 200

PUT

/v1/sections/{section_id}/submissions/bulk_mark_read

Mark bulk submissions as read

mark_bulk_submissions_as_read_sections 1 param body → 200

PUT

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/read/{item}

Mark submission item as read

mark_submission_item_as_read_courses 4 params → 200

PUT

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/read/{item}

Mark submission item as read

mark_submission_item_as_read_sections 4 params → 200

PUT

/v1/courses/{course_id}/submissions/{user_id}/clear_unread

Clear unread status for all submissions.

clear_unread_status_for_all_submissions_courses 2 params → 200

PUT

/v1/sections/{section_id}/submissions/{user_id}/clear_unread

Clear unread status for all submissions.

clear_unread_status_for_all_submissions_sections 2 params → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_comments/read

Get rubric assessments read state

get_rubric_assessments_read_state_courses_rubric_comments 3 params → 200

PUT

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_comments/read

Mark rubric assessments as read

mark_rubric_assessments_as_read_courses_rubric_comments 3 params → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_assessments/read

Get rubric assessments read state

get_rubric_assessments_read_state_courses_rubric_assessments 3 params → 200

PUT

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_assessments/read

Mark rubric assessments as read

mark_rubric_assessments_as_read_courses_rubric_assessments 3 params → 200

GET

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_comments/read

Get rubric assessments read state

get_rubric_assessments_read_state_sections_rubric_comments 3 params → 200

PUT

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_comments/read

Mark rubric assessments as read

mark_rubric_assessments_as_read_sections_rubric_comments 3 params → 200

GET

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_assessments/read

Get rubric assessments read state

get_rubric_assessments_read_state_sections_rubric_assessments 3 params → 200

PUT

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_assessments/read

Mark rubric assessments as read

mark_rubric_assessments_as_read_sections_rubric_assessments 3 params → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/document_annotations/read

Get document annotations read state

get_document_annotations_read_state_courses 3 params → 200

PUT

/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/document_annotations/read

Mark document annotations as read

mark_document_annotations_as_read_courses 3 params → 200

GET

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/document_annotations/read

Get document annotations read state

get_document_annotations_read_state_sections 3 params → 200

PUT

/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/document_annotations/read

Mark document annotations as read

mark_document_annotations_as_read_sections 3 params → 200

GET

/v1/courses/{course_id}/assignments/{assignment_id}/submission_summary

Submission Summary

submission_summary_courses 4 params → 200

GET

/v1/sections/{section_id}/assignments/{assignment_id}/submission_summary

Submission Summary

submission_summary_sections 4 params → 200

Tabs 5

GET

/v1/accounts/{account_id}/tabs

List available tabs for a course or group

list_available_tabs_for_course_or_group_accounts 2 params → 200

GET

/v1/courses/{course_id}/tabs

List available tabs for a course or group

list_available_tabs_for_course_or_group_courses 2 params → 200

GET

/v1/groups/{group_id}/tabs

List available tabs for a course or group

list_available_tabs_for_course_or_group_groups 2 params → 200

GET

/v1/users/{user_id}/tabs

List available tabs for a course or group

list_available_tabs_for_course_or_group_users 2 params → 200

PUT

/v1/courses/{course_id}/tabs/{tab_id}

Update a tab for a course

update_tab_for_course 2 params body → 200

Temporary Enrollment Pairings 5

GET

/v1/accounts/{account_id}/temporary_enrollment_pairings

List temporary enrollment pairings

list_temporary_enrollment_pairings 2 params → 200

POST

/v1/accounts/{account_id}/temporary_enrollment_pairings

Create Temporary Enrollment Pairing

create_temporary_enrollment_pairing 1 param body → 200

GET

/v1/accounts/{account_id}/temporary_enrollment_pairings/{id}

Get a single temporary enrollment pairing

get_single_temporary_enrollment_pairing 2 params → 200

DELETE

/v1/accounts/{account_id}/temporary_enrollment_pairings/{id}

Delete Temporary Enrollment Pairing

delete_temporary_enrollment_pairing 2 params → 200

GET

/v1/accounts/{account_id}/temporary_enrollment_pairings/new

New TemporaryEnrollmentPairing

new_temporaryenrollmentpairing 1 param → 200

User Observees 8

GET

/v1/users/{user_id}/observees

List linked observees

list_linked_observees 2 params → 200

POST

/v1/users/{user_id}/observees

Add an observee with credentials

add_observee_with_credentials 1 param body → 200

GET

/v1/users/{user_id}/observers

List linked observers

list_linked_observers 2 params → 200

GET

/v1/users/{user_id}/observees/{observee_id}

Show an observee

show_observee 2 params → 200

PUT

/v1/users/{user_id}/observees/{observee_id}

Add an observee

add_observee 2 params body → 200

DELETE

/v1/users/{user_id}/observees/{observee_id}

Remove an observee

remove_observee 3 params → 200

GET

/v1/users/{user_id}/observers/{observer_id}

Show an observer

show_observer 2 params → 200

POST

/v1/users/{user_id}/observer_pairing_codes

Create observer pairing code

create_observer_pairing_code 1 param → 200

Webhooks Subscriptions For Plagiarism Platform 5

POST

/lti/subscriptions

Create a Webhook Subscription

create_webhook_subscription body → 200

GET

/lti/subscriptions

List all Webhook Subscription for a tool proxy

list_all_webhook_subscription_for_tool_proxy → 200

DELETE

/lti/subscriptions/{id}

Delete a Webhook Subscription

delete_webhook_subscription 1 param → 200

GET

/lti/subscriptions/{id}

Show a single Webhook Subscription

show_single_webhook_subscription 1 param → 200

PUT

/lti/subscriptions/{id}

Update a Webhook Subscription

update_webhook_subscription 1 param → 200

What If Grades 2

PUT

/v1/submissions/{id}/what_if_grades

Update a submission's what-if score and calculate grades

update_submission_s_what_if_score_and_calculate_grades 1 param body → 200

PUT

/v1/courses/{course_id}/what_if_grades/reset

Reset the what-if scores for the current user for an entire course and recalculate grades

reset_what_if_scores_for_current_user_for_entire_course_and_recalculate_grades 1 param → 200

Schemas 283

The contract defines 283 schemas that model the data the API accepts and returns. The most detailed are Assignment (89 properties), ContextExternalTool (70 properties), Course (51 properties), Enrollment (44 properties). Each schema is shown below with its type and property counts.

Token

object

13 properties

AccessibilityCourseStatistic

object

Per-course accessibility issue counts for a user's active teacher/designer courses.

11 properties

AccountCalendar

object

13 properties

AccountNotification

object

8 properties

Report__account_reports

object

13 properties

ReportParameters__account_reports

object

The parameters returned will vary for each report.

18 properties

Account__accounts

object

17 properties

TermsOfService

object

6 properties

HelpLink

object

6 properties

HelpLinks

object

4 properties

Account__accounts_(lti)

object

6 properties

Admin

object

4 properties 1 required

AiExperience

object

An AI Experience for interactive learning

8 properties

ExternalFeed

object

6 properties

Scope

object

6 properties

Appointment

object

Date and time for an appointment

3 properties

AppointmentGroup

object

26 properties

AssessmentQuestionBank

object

9 properties 4 required

AssessmentQuestion

object

21 properties 1 required

AssignmentExtension

object

3 properties 2 required

GradingRules

object

3 properties

AssignmentGroup

object

8 properties

ExternalToolTagAttributes

object

3 properties

LockInfo

object

5 properties

RubricRating__assignments

object

4 properties

RubricCriteria

object

9 properties

AssignmentDate

object

Object representing a due date for an assignment or quiz. If the due date came from an assignment override, it will have an 'id' field.

6 properties

TurnitinSettings

object

8 properties

NeedsGradingCount

object

Used by Assignment model

2 properties

ScoreStatistic

object

Used by Assignment model

6 properties

Assignment

object

89 properties

BasicUser

object

2 properties

AssignmentOverride

object

16 properties

AuthenticationProvider

object

20 properties

SSOSettings

object

Settings that are applicable across an account's authentication configuration, even if there are multiple individual providers

6 properties

FederatedAttributesConfig

object

A mapping of Canvas attribute names to attribute names that a provider may send, in order to update the value of these attributes when a user logs in. The valu…

11 properties

FederatedAttributeConfig

object

A single attribute name to be federated when a user logs in

3 properties

AuthenticationEvent

object

5 properties

BlackoutDate

object

Blackout dates are used to prevent scheduling assignments on a given date in course pacing.

6 properties

BlockEditorTemplate

object

9 properties

BlueprintTemplate

object

5 properties

BlueprintMigration

object

10 properties

BlueprintRestriction

object

A set of restrictions on editing for copied objects in associated courses

4 properties

ChangeRecord

object

Describes a learning object change propagated to associated courses from a blueprint course

7 properties

ExceptionRecord

object

Lists associated courses that did not receive a change propagated from a blueprint

2 properties

BlueprintSubscription

object

Associates a course with a blueprint

3 properties

Bookmark

object

5 properties

CalendarEvent

object

38 properties

AssignmentEvent

object

19 properties

ExperienceSummary

object

2 properties

CareerUserContext

object

8 properties

Collaboration

object

14 properties

Collaborator

object

3 properties 1 required

CommMessage

object

11 properties

CommunicationChannel

object

8 properties

ConferenceRecording

object

5 properties

Conference

object

19 properties

ContentExport

object

7 properties

MigrationIssue

object

10 properties

ContentMigration

object

11 properties

Migrator

object

4 properties

ContentShare

object

Content shared between users

11 properties

Conversation

object

16 properties

ConversationParticipant

object

5 properties

CourseEventLink

object

6 properties

CourseEvent

object

6 properties

CreatedEventData

object

The created event data object returns all the fields that were set in the format of the following example. If a field does not exist it was not set. The value…

5 properties

UpdatedEventData

object

The updated event data object returns all the fields that have changed in the format of the following example. If a field does not exist it was not changed. Th…

4 properties

CoursePace

object

15 properties

Module__course_pace

object

6 properties

ModuleItem__course_pace

object

11 properties

Progress__course_pace

object

12 properties

CourseQuizExtension

object

5 properties 1 required

Report__course_reports

object

9 properties

ReportParameters__course_reports

object

The parameters returned will vary for each report.

Term

object

4 properties

CourseProgress

object

4 properties

Course

object

51 properties

CalendarLink

object

1 property

CustomColumn

object

6 properties

ColumnDatum

object

ColumnDatum objects contain the entry for a column for each user.

2 properties

DeveloperKeyAccountBinding

object

5 properties

DeveloperKey

object

a Canvas API key (or LTI 1.3 registration)

34 properties

DiscoveryPage

object

Configuration for the login discovery page

3 properties

DiscoveryPageEntry

object

A single authentication provider entry on the discovery page

3 properties

FileAttachment

object

A file attachment

4 properties

DiscussionTopic

object

A discussion topic

38 properties

ePortfolio

object

9 properties

ePortfolioPage

object

7 properties

CourseEpubExport

object

Combination of a Course & EpubExport.

3 properties

EpubExport

object

6 properties

EnrollmentTerm

object

9 properties

EnrollmentTermsList

object

1 property

Grade__enrollments

object

11 properties

Enrollment

object

44 properties

ErrorReport

object

A collection of information around a specific notification of a problem

7 properties

ContextExternalTool

object

An external tool configured for a specific context

70 properties

ContextExternalToolPlacement

object

Configuration for a specific placement of an external tool. If null, no configuration is present.

28 properties

ContextExternalToolMessageSettings

object

Configuration for a placementless message type (message type that doesn't belong to a specific placement)

4 properties

EstimatedDuration

object

An estimated duration for completing a learning activity

4 properties

Favorite

object

2 properties 1 required

Feature

object

9 properties

FeatureFlag

object

5 properties

File__files

object

23 properties

Folder

object

20 properties

UsageRights

object

Describes the copyright and license information for a File

6 properties

License

object

3 properties

GradeChangeEventLinks

object

5 properties

GradeChangeEvent

object

11 properties

Grader

object

3 properties

Day

object

2 properties

SubmissionVersion

object

A SubmissionVersion object contains all the fields that a Submission object does, plus additional fields prefixed with current new and previous described below.

23 properties

SubmissionHistory

object

2 properties

GradingPeriodSets

object

3 properties 1 required

GradingPeriod

object

7 properties 3 required

GradingSchemeEntry

object

3 properties

GradingStandard

object

7 properties

GroupCategory

object

12 properties

Group

object

20 properties

GroupMembership

object

7 properties

HistoryEntry

object

Information about a recently visited item or page in Canvas

10 properties 4 required

InstAccessToken

object

1 property

JWT

object

1 property

LatePolicy

object

11 properties

LearningObjectDates

object

14 properties

LineItem

object

8 properties

Result__live_assessments

object

A pass/fail results for a student

4 properties

ResultLinks

object

Unique identifiers of objects associated with a result

3 properties

Assessment

object

A simple assessment that collects pass/fail results for a student

3 properties

Lti::ContextControl

object

Represent availability of an LTI registration in a specific context

17 properties

Lti::LaunchDefinition

object

A bare-bones representation of an LTI tool used by Canvas to launch the tool

8 properties

Lti::PlacementLaunchDefinition

object

A bare-bones LTI configuration for a specific placement

3 properties

Lti::Registration

object

A registration of an LTI tool in Canvas

20 properties

Lti::RegistrationAccountBinding

object

A binding between an LTI registration and an account, defining the registration's availability in that account

9 properties

Lti::LegacyConfiguration

object

A legacy configuration format for LTI 1.3 tools.

10 properties

Lti::ToolConfiguration

object

A Registration's Canvas-specific tool configuration.

15 properties

Lti::LaunchSettings

object

Default launch settings for all placements

22 properties

Lti::Placement

object

The tool's configuration for a specific placement

24 properties

Lti::Overlay

object

Changes made by a Canvas admin to a tool's configuration.

10 properties

Lti::OverlayVersion

object

A single version of a tool's configuration overlay

8 properties

Lti::PlacementOverlay

object

Changes made by a Canvas admin to a tool's configuration for a specific placement.

7 properties

ListLtiRegistrationsResponse

object

The response for the List LTI Registrations API endpoint

2 properties

ContextSearchResponse

object

The response for the Search Accounts and Courses API endpoint

2 properties

SearchableAccount

object

A minimal representation of an Account for Canvas Apps search purposes

4 properties

SearchableCourse

object

A minimal representation of a Course for Canvas Apps search purposes

5 properties

Lti::ResourceLink

object

16 properties

MediaTrack

object

9 properties

MediaObject

object

7 properties

ProvisionalGrade

object

7 properties

Module__modules

object

15 properties

CompletionRequirement

object

4 properties

ContentDetails

object

7 properties

ModuleItem__modules

object

15 properties

ModuleItemSequenceNode

object

4 properties

ModuleItemSequence

object

2 properties

ModuleAssignmentOverride

object

5 properties

OverrideTarget

object

2 properties

NamesAndRoleContext

object

An abbreviated representation of an LTI Context

3 properties

NamesAndRoleMessage

object

Additional attributes which would appear in the LTI launch message were this member to click the specified resource link (rlid query parameter)

5 properties

NamesAndRoleMembership

object

A member of a LTI Context in one or more roles

10 properties

NamesAndRoleMemberships

object

3 properties

QuizItem

object

Individual items within a quiz, whether they're questions, stimuli, banked content, or question banks.

9 properties

QuestionItem

object

13 properties

StimulusItem

object

9 properties

BankEntryItem

object

7 properties

BankItem

object

5 properties

ItemProperties

object

1 property

QuestionFeedback

object

3 properties

NewQuiz

object

11 properties

QuizSettings

object

13 properties

MultipleAttemptsSettings

object

6 properties

ResultViewSettings

object

14 properties

AccommodationResponse

object

Response structure for processing accommodations

3 properties

CourseAccommodationRequest

object

Request format for setting course-level accommodations

4 properties

QuizAccommodationRequest

object

Request format for setting quiz-level accommodations

4 properties

Progress__new_quizzes_reports

object

10 properties

NoticeCatalog

object

Set of notice handlers (one per notice type) for an LTI tool deployment.

3 properties

NoticeHandler

object

A notice handler for a particular tool deployment and notice type.

3 properties

NotificationPreference

object

4 properties

ToolSetting

object

2 properties

OriginalityReport

object

9 properties

OutcomeGroup

object

12 properties

OutcomeLink

object

7 properties

OutcomeImportData

object

1 property

OutcomeImport

object

10 properties

OutcomeResult

object

A student's result for an outcome

5 properties

OutcomeRollupScoreLinks

object

1 property

OutcomeRollupScore

object

3 properties

OutcomeRollupLinks

object

3 properties

OutcomeRollup

object

3 properties

OutcomeAlignment__outcome_results

object

An asset aligned with this outcome

3 properties

OutcomePath

object

The full path to an outcome

2 properties

OutcomePathPart

object

An outcome or outcome group

1 property

Outcome

object

17 properties

OutcomeAlignment__outcomes

object

6 properties

Page

object

17 properties

PageRevision

object

7 properties

PeerReview

object

9 properties

LtiAssignment

object

A Canvas assignment

8 properties

Submission__plagiarism_detection_submissions

object

12 properties

File__plagiarism_detection_submissions

object

7 properties

PlannerNote

object

A planner note

11 properties

PlannerOverride

object

User-controlled setting for whether an item should be displayed on the planner or not

11 properties

PollChoice

object

5 properties 3 required

PollSession

object

9 properties 3 required

PollSubmission

object

4 properties 2 required

Poll

object

6 properties 2 required

ProficiencyRating

object

4 properties

Proficiency

object

1 property

Progress__progress

object

12 properties

QuizAssignmentOverrideSet

object

Set of assignment-overridden dates for a quiz.

3 properties

QuizAssignmentOverrideSetContainer

object

Container for set of assignment-overridden dates for a quiz.

1 property

QuizAssignmentOverride

object

Set of assignment-overridden dates for a quiz.

6 properties

QuizExtension

object

6 properties 2 required

QuizIPFilter

object

3 properties 3 required

QuizGroup

object

7 properties 2 required

QuizQuestion

object

13 properties 2 required

Answer

object

16 properties 2 required

QuizReport

object

13 properties

QuizStatistics

object

10 properties 2 required

QuizStatisticsLinks

object

Links to media related to QuizStatistics.

1 property

QuizStatisticsQuestionStatistics

object

Statistics for submissions made to a specific quiz question.

2 properties

QuizStatisticsAnswerStatistics

object

Statistics for a specific pre-defined answer in a Multiple-Choice or True/False quiz question.

4 properties

QuizStatisticsAnswerPointBiserial

object

A point-biserial construct for a single pre-defined answer in a Multiple-Choice or True/False question.

4 properties

QuizStatisticsSubmissionStatistics

object

Generic statistics for all submissions for a quiz.

9 properties

QuizSubmissionEvent

object

An event passed from the Quiz Submission take page

3 properties

QuizSubmissionQuestion

object

4 properties 1 required

QuizSubmissionUserList

object

QuizSubmissionUserListMeta

object

JSONAPIPagination

object

QuizSubmission

object

19 properties 2 required

Quiz

object

39 properties

QuizPermissions

object

Permissions the user has for the quiz

7 properties

Result__result

object

6 properties

RolePermissions

object

7 properties

Role

object

10 properties

Permission

object

A permission that can be granted to a role

6 properties

PermissionHelpText

object

Information about a permission, including its purpose and considerations for use.

2 properties

Rubric

object

12 properties

RubricCriterion

object

6 properties

RubricRating__rubrics

object

5 properties

RubricAssessment

object

11 properties

RubricAssociation

object

10 properties

Score

object

8 properties

Section

object

13 properties

SharedBrandConfig

object

6 properties

SisImportError

object

5 properties

SisImportData

object

3 properties

SisImportStatistic

object

5 properties

SisImportStatistics

object

14 properties

SisImportCounts

object

16 properties

SisImport

object

24 properties

SisAssignment

object

Assignments that have posttosis enabled with other objects for convenience

15 properties

AssignmentGroupAttributes

object

Some of the attributes of an Assignment Group. See Assignments API for more details

5 properties

SectionAttributes

object

Some of the attributes of a section. For more details see Sections API.

7 properties

CourseAttributes

object

Attributes of a course object. See Courses API for more details

4 properties

SectionAssignmentOverrideAttributes

object

Attributes of an assignment override that apply to the section object. See Assignments API for more details

4 properties

UserAssignmentOverrideAttributes

object

Attributes of assignment overrides that apply to users. See Assignments API for more details

6 properties

StudentAttributes

object

Attributes of student. See Users API for more details

2 properties

SearchResult

object

Reference to an object that matches a smart search

6 properties

MediaComment

object

5 properties

SubmissionComment

object

8 properties

Submission__submissions

object

31 properties

Tab

object

7 properties

TemporaryEnrollmentPairing

object

A pairing unique to that enrollment period given to a recipient of that temporary enrollment.

2 properties

PairingCode

object

A code used for linking a user to a student to observe them.

4 properties

UserDisplay

object

This mini-object is used for secondary user responses, when we just want to provide enough information to display a user.

4 properties

AnonymousUserDisplay

object

This mini-object is returned in place of UserDisplay when returning student data for anonymous assignments, and includes an anonymous ID to identify a user wit…

3 properties

User

object

A Canvas user, e.g. a student, teacher, administrator, observer, etc.

19 properties 1 required

Profile

object

Profile details for a Canvas user.

17 properties

Avatar

object

Possible avatar for a user.

8 properties 4 required

PageView

object

The record of a user page view access in Canvas

20 properties 1 required

PageViewLinks

object

The links of a page view access in Canvas

5 properties

AsyncApiErrorResponse

object

Error response structure returned by the API when validation or processing failures occur

1 property

AsyncQueryResponse

object

Response returned when successfully initiating a page views query

1 property 1 required

AsyncQueryStatusResponse

object

Response containing the current status of a page views query

5 properties 3 required

AsyncQueryResultsResponse

object

File download response containing page views query results

4 properties

CourseNickname

object

3 properties

Grade__what_if_grades

object

4 properties

AssignmentGroupGrade

object

7 properties

GradeGroup

object

1 property

Grades

object

4 properties

Submission__what_if_grades

object

2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Canvas publishes across the network.

Canvas LMS GraphQL API

AE Profile APIs.io

Canvas LTI Integrations

AE Profile APIs.io

Canvas Courses API

AE Profile APIs.io

#Education#LMS#REST

← Back to C APIs

Call it yourself

curl for this page

Search the network for this

curl "https://api.apievangelist.com/v1/search?q=canvas-lms-rest-api&limit=10"

Everything under a tag

curl "https://api.apievangelist.com/v1/tags/canvas-lms-rest-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Where this information came from

This is an independent, third-party profile of Canvas LMS REST API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Canvas LMS REST API

Metadata

Authentication & Security 2

Paths & Operations 1117

Schemas 283

Specification

Source

API Details

Provider

Explore more

Work with this as data

MCP tools for apis

Call it yourself

Get an API key

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Canvas LMS REST API

Metadata

Authentication & Security 2

Paths & Operations 1117

Schemas 283

Specification

Source

More from Canvas 3

API Details

Provider

Explore more

Work with this as data

MCP tools for apis

Call it yourself

Get an API key