Canvas

Learn how to use Canvas with Composio

Overview

SLUG

CANVAS

Description

Canvas is a learning management system supporting online courses, assignments, grading, and collaboration, widely used by schools and universities for virtual classrooms

Authentication Details

client_id
stringRequired
client_secret
stringRequired
full
stringDefaults to https://canvas.instructure.comRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
string
bearer_token
string
full
stringRequired
generic_api_key
stringRequired

Tools

SLUG: CANVAS_CREATE_COURSE

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_FETCH_DATA

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

Action Parameters

account_id
integer
assignment_id
integer
course_id
integer
enrollment_state
string
enrollment_type
string
get_accounts
boolean
get_assignments
boolean
get_courses
boolean
get_discussion_topics
boolean
get_files
boolean
get_pages
boolean
get_quizzes
boolean
get_submissions
boolean
get_user_courses
boolean
get_users
boolean
search_term
string
user_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_ACCOUNTS

Retrieves all canvas accounts accessible to the authenticated user.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_ALL_ASSIGNMENTS

Retrieves assignments for a specified canvas course.

Action Parameters

course_id
integerRequired
per_page
integerDefaults to 10

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_CURRENT_USER

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_SUBMISSION_FILES

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

Action Parameters

assignment_id
stringRequired
course_id
stringRequired
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_COURSES

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

Action Parameters

enrollment_state
string
enrollment_type
string
per_page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_UPDATE_COURSE_SETTINGS

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_ACCOUNT_NOTIFICATION

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_APPOINTMENT_GROUP

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_ASSIGNMENT

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_ASSIGNMENT_OVERRIDE

Creates an assignment override to adjust due/unlock/lock dates for an assignment in a course, targeting specific students (requires `title`), a group, or a course section; at least one target (`student ids`, `group id`, or `course section id`) is required.

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_CALENDAR_EVENT

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_COMMUNICATION_CHANNEL

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

Action Parameters

address
stringRequired
token
string
type
stringRequired
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_CONTENT_SHARE

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

Action Parameters

content_id
integerRequired
content_type
stringRequired
receiver_ids
arrayRequired
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_CONVERSATION

Use to send messages in canvas by creating a new conversation or adding to an existing one; an existing conversation with the same recipients (and matching scope/filter, if specified) may be reused unless `force new` is true.

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_DISCUSSION_TOPIC

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_ENROLLMENT

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_FOLDER

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_MODULE

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_PAGE_FOR_COURSE

Creates a new wiki page in a specified canvas course, with options for title, html body, editing permissions, publication, and designation as front page (which also requires publication).

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_QUIZ

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_CREATE_QUIZ_QUESTION

Creates a new question for an existing quiz within a course; if `answers` are provided, their structure must align with `question type`, and any `quiz group id` must be valid for an existing group in the quiz.

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_DELETE_APPOINTMENT_GROUP

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

Action Parameters

appointment_group_id
stringRequired
cancel_reason
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_DELETE_ASSIGNMENT

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

Action Parameters

assignment_id
integerRequired
course_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_DELETE_FOLDER

Permanently deletes an existing folder specified by its unique id.

Action Parameters

force
boolean
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_DELETE_QUIZ

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

Action Parameters

course_id
stringRequired
quiz_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_DEPARTMENT_LEVEL_GRADE_DATA_FOR_CURRENT_GRADES

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

Action Parameters

account_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_DEPARTMENT_LEVEL_GRADE_DATA_FOR_TERM_GRADES

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

Action Parameters

account_id
integerRequired
term_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_EDIT_ASSIGNMENT

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_EDIT_QUIZ

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_EXPORT_CONTENT

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

Action Parameters

course_id
stringRequired
export_type
stringRequired
skip_notifications
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_ALL_USERS

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

Action Parameters

account_id
stringRequired
enrollment_type
array
include_deleted_users
boolean
order
string
page
integerDefaults to 1
per_page
integerDefaults to 100
search_term
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_ASSIGNMENT

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

Action Parameters

assignment_id
integerRequired
course_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_ASSIGNMENT_RUBRIC

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

Action Parameters

assignment_id
stringRequired
course_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_COURSE_LEVEL_PARTICIPATION_DATA

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

Action Parameters

course_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_DEPARTMENT_LEVEL_COMPLETED_STATISTICS

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

Action Parameters

account_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_DEPARTMENT_LEVEL_CURRENT_STATISTICS

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

Action Parameters

account_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_DEPARTMENT_LEVEL_GRADE_DATA_COMPLETED_GRADES

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

Action Parameters

account_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_DEPARTMENT_LEVEL_TERM_STATISTICS

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

Action Parameters

account_id
integerRequired
term_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_ENROLLMENT_BY_ID

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

Action Parameters

account_id
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_GRADEBOOK_HISTORY_DAYS

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

Action Parameters

course_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_PAGE_FOR_COURSE

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

Action Parameters

course_id
stringRequired
url_or_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_QUIZ_SUBMISSIONS

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

Action Parameters

course_id
stringRequired
include
array
quiz_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_REPORT_STATUS

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

Action Parameters

account_id
integerRequired
id
integerRequired
report
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_SINGLE_COURSE

Retrieves detailed information for a specific canvas course using its `course id`, which must be valid, and allows for including additional data fields in the response via the `include` parameter.

Action Parameters

course_id
integerRequired
include
array
teacher_limit
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_SINGLE_SUBMISSION

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

Action Parameters

assignment_id
integerRequired
course_id
integerRequired
include
array
user_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_USER_ASSIGNMENT_ANALYTICS

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

Action Parameters

course_id
integerRequired
student_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_USER_COURSE_PROGRESS

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

Action Parameters

course_id
integerRequired
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_USER_PARTICIPATION_ANALYTICS

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

Action Parameters

course_id
integerRequired
student_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GET_USER_PROFILE

Retrieves profile information for an existing canvas user.

Action Parameters

user_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_GRADE_COMMENT_SUBMISSION

Updates a student's assignment submission with a grade, comment, sticker, or status change; requires `course id`, `assignment id`, `user id`, and at least one update field.

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_ACCOUNTS_FOR_COURSE_ADMINS

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_ALL_FOLDERS

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

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_APPOINTMENT_GROUPS

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

Action Parameters

context_codes
array
include
array
include_past_appointments
boolean
scope
stringDefaults to reservable

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_ASSIGNMENT_SUBMISSIONS

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

Action Parameters

assignment_id
integerRequired
course_id
integerRequired
grouped
boolean
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_AVAILABLE_REPORTS

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

Action Parameters

account_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_CALENDAR_EVENTS_FOR_USER

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_COMMUNICATION_CHANNELS

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

Action Parameters

user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_COMM_MESSAGES

Retrieves communication messages from canvas.

Action Parameters

end_time
string
start_time
string
user_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_CONTENT_EXPORTS

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

Action Parameters

course_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_COURSES_FOR_USER

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_COURSE_USERS

Retrieves a paginated list of users for a given canvas `course id` (which must be an existing course), supporting various filtering, sorting, and data inclusion options.

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_DISCUSSION_TOPICS

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_FILES

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

Action Parameters

course_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_FOLDERS

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

Action Parameters

folder_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_PAGES_FOR_COURSE

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

Action Parameters

course_id
integerRequired
order
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_QUIZZES_IN_COURSE

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

Action Parameters

course_id
stringRequired
page
integer
per_page
integer
search_term
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_SENT_CONTENT_SHARES

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

Action Parameters

user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_SUBMISSIONS

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

Action Parameters

assignment_id
integerRequired
course_id
integerRequired
date
stringRequired
grader_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_SUBMISSIONSFOR_MULTIPLE_ASSIGNMENTS

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

Action Parameters

assignment_ids
array
course_id
integerRequired
student_ids
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_UNCOLLATED_SUBMISSION_VERSIONS

Retrieves a feed of uncollated submission versions from the gradebook history for a course; any provided `assignment id` must be valid for the course, and any `user id` must be for a user enrolled in the course.

Action Parameters

ascending
boolean
assignment_id
integer
course_id
integerRequired
user_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_LIST_USERS_IN_ACCOUNT

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

Action Parameters

account_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_RETRIEVE_ENROLLMENT_TERM

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

Action Parameters

account_id
stringRequired
term_id
stringRequired

Action Response

data
object
error
string
successful
booleanRequired

SLUG: CANVAS_START_REPORT

Initiates an asynchronous report generation for a canvas account, using a valid report type for the account; the response confirms initiation and may include progress tracking details.

Action Parameters

account_id
integerRequired
parameters
object
report
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_TRANSLATE_FILE_REFERENCE

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

Action Parameters

course_id
stringRequired
migration_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_UPDATE_APPOINTMENT_GROUP

Updates an existing canvas appointment group by its id; only provided fields are modified, but `publish` defaults to `false` if omitted. the `appointment group id` must be valid.

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_UPDATE_COURSE

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_UPDATE_FILE

Modifies an existing file's name or relocates it to a new parent folder; the target folder, if specified, must be valid and in the file's original context.

Action Parameters

file_id
stringRequired
name
string
on_duplicate
string
parent_folder_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_UPDATE_PAGE_FOR_COURSE

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_UPDATE_QUIZ_SUBMISSION_SCORES

Updates scores, comments for questions, and/or applies fudge points to a specific quiz submission attempt; the attempt must be completed and referenced by valid, existing course, quiz, and submission ids.

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_UPDATE_USER_SETTINGS

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_UPLOAD_COURSE_FILE

Uploads a file to an accessible canvas course, optionally to a specific folder (created if a non-existent `parent folder path` is provided) and with defined behavior for duplicate filenames.

Action Parameters

course_id
stringRequired
file
objectRequired
on_duplicate
string
parent_folder_id
integer
parent_folder_path
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CANVAS_UPLOAD_SUBMISSION_FILE

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

Action Parameters

assignment_id
stringRequired
course_id
stringRequired
file
objectRequired
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired