Canvas

Learn how to use Canvas with Composio

Overview

Enum

CANVAS

Description

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

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
string
base_url
stringDefaults to https://canvas.instructure.com
apiKey
stringRequired
base_url
stringRequired

Actions

Creates a quiz question in canvas.

Action Parameters

course_id
integerRequired
quiz_id
integerRequired
question_name
stringRequired
question_text
stringRequired
quiz_group_id
integer
question_type
stringRequired
position
integer
points_possible
integer
correct_comments
string
incorrect_comments
string
neutral_comments
string
text_after_answers
string
answers
array

Action Response

data
object
successful
boolean
error

Lists all folders in a canvas course, user, or group context.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Creates a quiz in canvas.

Action Parameters

course_id
stringRequired
title
stringRequired
description
string
quiz_type
string
assignment_group_id
integer
time_limit
integer
shuffle_answers
boolean
hide_results
string
show_correct_answers
boolean
show_correct_answers_last_attempt
boolean
show_correct_answers_at
string
hide_correct_answers_at
string
allowed_attempts
integer
scoring_policy
string
one_question_at_a_time
boolean
cant_go_back
boolean
access_code
string
ip_filter
string
due_at
string
lock_at
string
unlock_at
string
published
boolean
one_time_results
boolean
only_visible_to_overrides
boolean

Action Response

data
object
successful
boolean
error

Lists sent content shares in canvas.

Action Parameters

user_id
stringRequired

Action Response

data
object
successful
boolean
error

Creates a new discussion topic for a course in canvas.

Action Parameters

course_id
integerRequired
title
stringRequired
message
string
discussion_type
string
published
boolean
delayed_post_at
string
allow_rating
boolean
lock_at
string
podcast_enabled
boolean
podcast_has_student_posts
boolean
require_initial_post
boolean
is_announcement
boolean
pinned
boolean
position_after
string
group_category_id
integer
only_graders_can_rate
boolean
sort_by_rating
boolean
specific_sections
string

Action Response

data
object
successful
boolean
error

Updates a user’s settings in canvas.

Action Parameters

user_id
integerRequired
manual_mark_as_read
boolean
release_notes_badge_disabled
boolean
collapse_global_nav
boolean
collapse_course_nav
boolean
hide_dashcard_color_overlays
boolean
comment_library_suggestions_enabled
boolean
elementary_dashboard_disabled
boolean

Action Response

data
object
successful
boolean
error

Lists users in an account in canvas.

Action Parameters

account_id
integerRequired

Action Response

data
object
successful
boolean
error

Creates a page for a course in canvas.

Action Parameters

course_id
integerRequired
title
stringRequired
body
string
editing_roles
string
notify_of_update
boolean
published
boolean
front_page
boolean

Action Response

data
object
successful
boolean
error

Updates student question scores and comments for a quiz submission.

Action Parameters

course_id
stringRequired
quiz_id
stringRequired
id
stringRequired
attempt
integerRequired
fudge_points
number
questions
object

Action Response

data
object
successful
boolean
error

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

Action Parameters

account_id
integerRequired

Action Response

data
object
successful
boolean
error

Lists accounts for course admins in canvas.

Action Parameters

Action Response

data
object
successful
boolean
error

Creates a module in canvas.

Action Parameters

course_id
stringRequired
name
stringRequired
unlock_at
string
position
integer
require_sequential_progress
boolean
prerequisite_module_ids
array
publish_final_grade
boolean

Action Response

data
object
successful
boolean
error

Deletes an assignment in canvas.

Action Parameters

course_id
integerRequired
assignment_id
integerRequired

Action Response

data
object
successful
boolean
error

Gets a single course in canvas.

Action Parameters

course_id
integerRequired
include
array
teacher_limit
integer

Action Response

data
object
successful
boolean
error

Gets an assignment in canvas.

Action Parameters

course_id
integerRequired
assignment_id
integerRequired

Action Response

data
object
successful
boolean
error

Lists quizzes in a canvas course.

Action Parameters

course_id
stringRequired
search_term
string

Action Response

data
object
successful
boolean
error

Update an existing course

Action Parameters

id
stringRequired
account_id
integer
name
string
course_code
string
start_at
string
end_at
string
license
string
is_public
boolean
is_public_to_auth_users
boolean
public_syllabus
boolean
public_syllabus_to_auth
boolean
public_description
string
allow_student_wiki_edits
boolean
allow_wiki_comments
boolean
allow_student_forum_attachments
boolean
open_enrollment
boolean
self_enrollment
boolean
restrict_enrollments_to_course_dates
boolean
term_id
integer
event
string
default_view
string
syllabus_body
string
override_sis_stickiness
booleanDefaults to True

Action Response

data
object
successful
boolean
error

Creates a new course in canvas.

Action Parameters

account_id
stringRequired
name
string
course_code
string
start_at
string
end_at
string
license
string
is_public
boolean
is_public_to_auth_users
boolean
public_syllabus
boolean
public_syllabus_to_auth
boolean
public_description
string
allow_student_wiki_edits
boolean
allow_wiki_comments
boolean
allow_student_forum_attachments
boolean
open_enrollment
boolean
self_enrollment
boolean
restrict_enrollments_to_course_dates
boolean
term_id
string
sis_course_id
string
integration_id
string
hide_final_grades
boolean
apply_assignment_group_weights
boolean
time_zone
string
default_view
string
syllabus_body
string
grading_standard_id
integer
grade_passback_setting
string
course_format
string
post_manually
boolean
offer
boolean
enroll_me
boolean
enable_sis_reactivation
boolean

Action Response

data
object
successful
boolean
error

Lists all courses in canvas.

Action Parameters

enrollment_type
string
enrollment_state
string

Action Response

data
object
successful
boolean
error

Lists available reports in canvas.

Action Parameters

account_id
integerRequired

Action Response

data
object
successful
boolean
error

Gets current statistics for an account in canvas.

Action Parameters

account_id
integerRequired

Action Response

data
object
successful
boolean
error

Gets current grades for an account in canvas.

Action Parameters

account_id
integerRequired

Action Response

data
object
successful
boolean
error

Lists communication messages for a user in canvas.

Action Parameters

user_id
string
start_time
string
end_time
string

Action Response

data
object
successful
boolean
error

Creates a communication channel for a user in canvas.

Action Parameters

user_id
stringRequired
address
stringRequired
type
stringRequired
token
string

Action Response

data
object
successful
boolean
error

Updates course settings in canvas.

Action Parameters

course_id
integerRequired
allow_final_grade_override
boolean
allow_student_discussion_topics
boolean
allow_student_forum_attachments
boolean
allow_student_discussion_editing
boolean
allow_student_organized_groups
boolean
allow_student_discussion_reporting
boolean
allow_student_anonymous_discussion_topics
boolean
filter_speed_grader_by_student_group
boolean
hide_final_grades
boolean
hide_distribution_graphs
boolean
hide_sections_on_course_users_page
boolean
lock_all_announcements
boolean
usage_rights_required
boolean
restrict_student_past_view
boolean
restrict_student_future_view
boolean
show_announcements_on_home_page
boolean
home_page_announcement_limit
integer
syllabus_course_summary
boolean
default_due_time
string
conditional_release
boolean

Action Response

data
object
successful
boolean
error

Translates a file reference for a course in canvas.

Action Parameters

course_id
stringRequired
migration_id
stringRequired

Action Response

data
object
successful
boolean
error

Creates a conversation in canvas.

Action Parameters

recipients
arrayRequired
subject
string
body
stringRequired
force_new
boolean
group_conversation
boolean
attachment_ids
array
media_comment_id
string
media_comment_type
string
mode
string
scope
string
filter
array
filter_mode
string
context_code
string

Action Response

data
object
successful
boolean
error

Uploads a file to a submission in canvas.

Action Parameters

course_id
stringRequired
assignment_id
stringRequired
user_id
stringRequired
file
objectRequired

Action Response

data
object
successful
boolean
error

Deletes a quiz in canvas.

Action Parameters

course_id
stringRequired
quiz_id
stringRequired

Action Response

data
object
successful
boolean
error

Returns assignment analytics data for a specific student in a course. the data includes assignment details, grade statistics, and the student’s submission information.

Action Parameters

course_id
integerRequired
student_id
integerRequired

Action Response

data
object
successful
boolean
error

Creates an enrollment in canvas for a user in a course.

Action Parameters

course_id
integerRequired
user_id
stringRequired
enrollment_type
string
enrollment_state
stringDefaults to invited
start_at
string
end_at
string
role_id
integer
course_section_id
integer
limit_privileges_to_course_section
boolean
notify
boolean
self_enrollment_code
string
self_enrolled
boolean
associated_user_id
integer
sis_user_id
string
integration_id
string

Action Response

data
object
successful
boolean
error

Gets completed statistics for an account in canvas.

Action Parameters

account_id
integerRequired

Action Response

data
object
successful
boolean
error

Lists submissions for a specific assignment, grader, and date in canvas.

Action Parameters

course_id
integerRequired
date
stringRequired
grader_id
integerRequired
assignment_id
integerRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

course_id
integerRequired
student_id
integerRequired

Action Response

data
object
successful
boolean
error

Gets department level current data for term grades in canvas.

Action Parameters

account_id
integerRequired
term_id
integerRequired

Action Response

data
object
successful
boolean
error

Lists uncollated submission versions for a specific course in canvas.

Action Parameters

course_id
integerRequired
assignment_id
integer
user_id
integer
ascending
boolean

Action Response

data
object
successful
boolean
error

Creates a folder in canvas within the specified context (course, user, group, folder, or account).

Action Parameters

context_type
stringRequired
id
stringRequired
name
stringRequired
parent_folder_id
string
parent_folder_path
string
lock_at
string
unlock_at
string
locked
boolean
hidden
boolean
position
integer

Action Response

data
object
successful
boolean
error

Gets all assignments in a course in canvas.

Action Parameters

course_id
integerRequired
per_page
integerDefaults to 10

Action Response

data
object
successful
boolean
error

Gets appointment groups in canvas.

Action Parameters

scope
stringDefaults to reservable
context_codes
array
include_past_appointments
boolean
include
array

Action Response

data
object
successful
boolean
error

Exports content in a course in canvas.

Action Parameters

course_id
stringRequired
export_type
stringRequired
skip_notifications
boolean

Action Response

data
object
successful
boolean
error

Creates a new global notification for an account in canvas.

Action Parameters

account_id
stringRequired
subject
stringRequired
message
stringRequired
start_at
stringRequired
end_at
stringRequired
icon
stringDefaults to warning
notification_roles
array

Action Response

data
object
successful
boolean
error

Uploads a file to a canvas course.

Action Parameters

course_id
stringRequired
file
objectRequired
parent_folder_path
string
parent_folder_id
integer
on_duplicate
string

Action Response

data
object
successful
boolean
error

Lists calendar events for a user in canvas.

Action Parameters

user_id
integerRequired
type
stringDefaults to event
start_date
string
end_date
string
undated
boolean
all_events
boolean
context_codes
array
excludes
array
submission_types
array
exclude_submission_types
array
includes
array
important_dates
boolean
blackout_date
boolean

Action Response

data
object
successful
boolean
error

Grades or comments on a submission in canvas.

Action Parameters

course_id
integerRequired
assignment_id
integerRequired
user_id
integerRequired
text_comment
string
attempt
integer
group_comment
boolean
media_comment_id
string
media_comment_type
string
posted_grade
string
sticker
string
excuse
boolean
late_policy_status
string
seconds_late_override
integer

Action Response

data
object
successful
boolean
error

Gets a page for a course in canvas.

Action Parameters

course_id
stringRequired
url_or_id
stringRequired

Action Response

data
object
successful
boolean
error

Updates a page for a course in canvas.

Action Parameters

course_id
stringRequired
url_or_id
stringRequired
title
string
body
string
editing_roles
string
notify_of_update
boolean
published
boolean
front_page
boolean

Action Response

data
object
successful
boolean
error

Retrieves an enrollment term in canvas. note: the specified account must be a root account, not a sub-account. for more details see: https://canvas.instructure.com/doc/api/enrollment terms.html

Action Parameters

account_id
stringRequired
term_id
stringRequired

Action Response

data
object
successful
boolean
error

Gets all quiz submissions for a quiz in canvas.

Action Parameters

course_id
stringRequired
quiz_id
stringRequired
include
array

Action Response

data
object
successful
boolean
error

Lists assignment submissions in canvas.

Action Parameters

course_id
integerRequired
assignment_id
integerRequired
include
array
grouped
boolean

Action Response

data
object
successful
boolean
error

Lists communication channels for a user in canvas.

Action Parameters

user_id
stringRequired

Action Response

data
object
successful
boolean
error

Gets details of the current user in canvas.

Action Parameters

Action Response

data
object
successful
boolean
error

Updates an appointment group in canvas.

Action Parameters

appointment_group_id
stringRequired
context_codes
array
sub_context_codes
array
title
string
description
string
location_name
string
location_address
string
publish
boolean
participants_per_appointment
integer
min_appointments_per_participant
integer
max_appointments_per_participant
integer
participant_visibility
string
allow_observer_signup
boolean

Action Response

data
object
successful
boolean
error

Deletes a folder in canvas.

Action Parameters

id
stringRequired
force
boolean

Action Response

data
object
successful
boolean
error

Returns the paginated list of users in a course, optionally including their enrollments.

Action Parameters

course_id
stringRequired
search_term
string
sort
string
enrollment_type
array
enrollment_role
string
enrollment_role_id
integer
include
array
user_id
string
user_ids
array
enrollment_state
array

Action Response

data
object
successful
boolean
error

Deletes an appointment group in canvas.

Action Parameters

appointment_group_id
stringRequired
cancel_reason
string

Action Response

data
object
successful
boolean
error

Lists all folders within the specified folder in canvas.

Action Parameters

folder_id
stringRequired

Action Response

data
object
successful
boolean
error

Starts a report in canvas.

Action Parameters

account_id
integerRequired
report
stringRequired
parameters
object

Action Response

data
object
successful
boolean
error

Create and return a new calendar event

Action Parameters

context_code
stringRequired
title
string
description
string
start_at
string
end_at
string
location_name
string
location_address
string
time_zone_edited
string
all_day
boolean
child_event_data
object
duplicate
object
rrule
string
blackout_date
boolean

Action Response

data
object
successful
boolean
error

Updates the name of a file in canvas.

Action Parameters

file_id
stringRequired
name
string
parent_folder_id
string
on_duplicate
string

Action Response

data
object
successful
boolean
error

Gets the status of a report in canvas.

Action Parameters

account_id
integerRequired
report
stringRequired
id
integerRequired

Action Response

data
object
successful
boolean
error

Creates a content share in canvas. this action allows sharing content directly between two or more users. requires proper authentication and valid user ids.

Action Parameters

user_id
stringRequired
receiver_ids
arrayRequired
content_type
stringRequired
content_id
integerRequired

Action Response

data
object
successful
boolean
error

Gets a user’s profile in canvas.

Action Parameters

user_id
integerRequired

Action Response

data
object
successful
boolean
error

Lists files for a course in canvas.

Action Parameters

course_id
stringRequired

Action Response

data
object
successful
boolean
error

Returns the paginated list of discussion topics for a course.

Action Parameters

course_id
integerRequired
include
array
order_by
string
scope
string
only_announcements
boolean
filter_by
string
search_term
string
exclude_context_module_locked_topics
boolean

Action Response

data
object
successful
boolean
error

Creates an assignment in canvas.

Action Parameters

course_id
integerRequired
name
stringRequired
position
integer
submission_types
array
allowed_extensions
array
grading_type
string
due_at
string
unlock_at
string
points_possible
integer
description
string
published
boolean
assignment_group_id
integer
allowed_attempts
integer
integration_id
string

Action Response

data
object
successful
boolean
error

Returns a list of day objects containing dates and graders who worked on those dates. each day object contains a date and an array of graders who worked on that date.

Action Parameters

course_id
stringRequired

Action Response

data
object
successful
boolean
error

Creates an appointment group in canvas.

Action Parameters

context_codes
arrayRequired
sub_context_codes
array
title
stringRequired
description
string
location_name
string
location_address
string
publish
boolean
participants_per_appointment
integer
min_appointments_per_participant
integer
max_appointments_per_participant
integer
participant_visibility
stringDefaults to private
allow_observer_signup
boolean

Action Response

data
object
successful
boolean
error

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

Action Parameters

user_id
integerRequired
include
array
state
array
enrollment_state
string
homeroom
boolean
account_id
string

Action Response

data
object
successful
boolean
error

Gets term statistics for an account in canvas.

Action Parameters

account_id
integerRequired
term_id
integerRequired

Action Response

data
object
successful
boolean
error

Gets a single submission in canvas.

Action Parameters

course_id
integerRequired
assignment_id
integerRequired
user_id
integerRequired
include
array

Action Response

data
object
successful
boolean
error

Lists submissions for multiple assignments in canvas.

Action Parameters

course_id
integerRequired
student_ids
array
assignment_ids
array

Action Response

data
object
successful
boolean
error

Lists content exports in a course in canvas.

Action Parameters

course_id
stringRequired

Action Response

data
object
successful
boolean
error

Creates an assignment override in canvas.

Action Parameters

course_id
stringRequired
assignment_id
stringRequired
student_ids
array
title
string
group_id
integer
course_section_id
integer
due_at
string
unlock_at
string
lock_at
string

Action Response

data
object
successful
boolean
error

Edits an assignment in canvas.

Action Parameters

course_id
integerRequired
assignment_id
integerRequired
name
string
position
integer
submission_types
array
allowed_extensions
array
grading_type
string
due_at
string
unlock_at
string
points_possible
integer
description
string
published
boolean
assignment_group_id
integer
allowed_attempts
integer
integration_id
string

Action Response

data
object
successful
boolean
error

Edits a quiz in canvas.

Action Parameters

course_id
stringRequired
quiz_id
stringRequired
notify_of_update
booleanDefaults to True
title
string
description
string
quiz_type
string
assignment_group_id
integer
time_limit
integer
shuffle_answers
boolean
hide_results
string
show_correct_answers
boolean
show_correct_answers_last_attempt
boolean
show_correct_answers_at
string
hide_correct_answers_at
string
allowed_attempts
integer
scoring_policy
string
one_question_at_a_time
boolean
cant_go_back
boolean
access_code
string
ip_filter
string
due_at
string
lock_at
string
unlock_at
string
published
boolean
one_time_results
boolean
only_visible_to_overrides
boolean

Action Response

data
object
successful
boolean
error

Returns progress information for a specific user in a course. the user can query their own progress using ‘self’ as the user id. to query another user’s progress, the requester must be a teacher, administrator, or linked observer.

Action Parameters

course_id
integerRequired
user_id
stringRequired

Action Response

data
object
successful
boolean
error

Gets activity analytics for a course in canvas.

Action Parameters

course_id
integerRequired

Action Response

data
object
successful
boolean
error

Get an enrollment object by enrollment id

Action Parameters

account_id
stringRequired
id
stringRequired

Action Response

data
object
successful
boolean
error

Lists pages for a course in canvas.

Action Parameters

course_id
integerRequired
sort
string
order
string

Action Response

data
object
successful
boolean
error